Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ApexDoc comment syntax validation #3

Closed
SCWells72 opened this issue Mar 2, 2023 · 1 comment
Closed

ApexDoc comment syntax validation #3

SCWells72 opened this issue Mar 2, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@SCWells72
Copy link
Owner

SCWells72 commented Mar 2, 2023

Provide optional validation of ApexDoc comments, specifically the following:

  • Missing doc comment on a declaration that meets/exceeds the minimum configured minimum visibility. Needs to be able to ignore missing comments on:
    • Deprecated either via annotation or ApexDoc tag
    • Inherited from base declaration
    • Extends/overrides system Apex type/method
  • Unresolvable reference
  • Missing, incomplete, or extraneous @param tag(s)
  • Missing, incomplete, or extraneous @return tag
  • Missing @exception/@throws tag exception type name and/or description
  • Missing @see tag reference and/or description
  • Missing @author tag value
  • Missing @group tag value
  • Missing @date tag value
  • Missing @since tag value
  • Missing @example tag value
  • Missing @deprecated tag description
  • Missing custom object/field description text

It would need to be possible for the user to enable/disable this entirely as well as to determine which validation rules should be used.

@SCWells72 SCWells72 added the enhancement New feature or request label Mar 2, 2023
@SCWells72
Copy link
Owner Author

Delivered in 1.0.0.3.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant