Class DocumentationCommentBasicDelegateCheck

  • All Implemented Interfaces:
    ITopObjectFilter, ICheck

    public abstract class DocumentationCommentBasicDelegateCheck
    extends BasicCheck
    Basic documentation comment check. Delelopers should use it to perform easier validations of documenting comments
    • Constructor Detail

      • DocumentationCommentBasicDelegateCheck

        public DocumentationCommentBasicDelegateCheck()
    • Method Detail

      • check

        protected final void check​(Object object,
                                   BasicCheck.ResultAcceptor resultAcceptor,
                                   ICheckParameters parameters,
                                   org.eclipse.core.runtime.IProgressMonitor progressMonitor)
        Description copied from class: BasicCheck
        The method that performs the check. Check results (issues) need to be placed into the result acceptor. Validation may be cancelled by a user. Complex implemantations should take this into the account and check IProgressMonitor.isCanceled() periodically during long-running operations.
        Specified by:
        check in class BasicCheck
        Parameters:
        object - The object to check, not null
        resultAcceptor - Result acceptor, not null
        parameters - The set of check execution parameters taken from check settings, not null
        progressMonitor - Current check progress monitor, not null
      • checkDocumentationCommentObject

        protected abstract void checkDocumentationCommentObject​(IDescriptionPart descriptionPart,
                                                                BslDocumentationComment rootNode,
                                                                DocumentationCommentBasicDelegateCheck.DocumentationCommentResultAcceptor resultAceptor,
                                                                ICheckParameters parameters,
                                                                org.eclipse.core.runtime.IProgressMonitor progressMonitor)
        Checks the documentation comment model object. Check developers should implement their main check logic by overriding this method
        Parameters:
        descriptionPart - The checked part of the documentation comment model. May not be null
        rootNode - The root node of the documentation comment model. May not be null
        resultAceptor - The check's result acceptor. May not be null
        parameters - The accessor of the check's parameters. May not be null
        progressMonitor - The progress monitor. It should be checked for the canceling in case of the long/complex checks. May not be null