Uploaded image for project: 'Ignite'
  1. Ignite
  2. IGNITE-21582

Checkstyle: introduce a separate javadoc rules for public api module

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • None
    • Docs Required, Release Notes Required

    Description

      Introduce separate checkstyle ruleset for public API module (modules/api). This ruleset should be more strict than internal one:

      • All public method must have Javadocs (currently in internal code field getters may haven't Javadocs)
      •  /** {@inheritDoc} */ is not applicable for public API 

      Attachments

        Issue Links

          is related to

          Improvement - An improvement or enhancement to an existing feature or task. IGNITE-21467 Improve PMD and Checkstyle rulesets

          • Major - Major loss of function.
          • Resolved

          Activity

            People

              vblinov Viacheslav Blinov
              vblinov Viacheslav Blinov
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: