diff --git a/feed.xml b/feed.xml index 1fbb97aee2..bd6b0fe190 100644 --- a/feed.xml +++ b/feed.xml @@ -5,8 +5,8 @@ Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features. https://pmd.github.io/pmd/ - Fri, 22 Oct 2021 17:21:56 +0000 - Fri, 22 Oct 2021 17:21:56 +0000 + Fri, 22 Oct 2021 17:28:17 +0000 + Fri, 22 Oct 2021 17:28:17 +0000 Jekyll v3.9.0 diff --git a/pmd_rules_apex_documentation.html b/pmd_rules_apex_documentation.html index eb528d1336..80ddd3fd67 100644 --- a/pmd_rules_apex_documentation.html +++ b/pmd_rules_apex_documentation.html @@ -1444,7 +1444,7 @@ $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3 overrides and test classes (as well as the contents of test classes).
  • ApexDoc comments are present for classes, methods, and properties that are protected or private, depending on the properties reportPrivate and reportProtected.
    • -
  • ApexDoc comments should contain @description.
    • +
  • ApexDoc comments should contain @description depending on the property ‘reportMissingDescription’.
  • ApexDoc comments on non-void, non-constructor methods should contain @return.
  • ApexDoc comments on void or constructor methods should not contain @return.
  • ApexDoc comments on methods with parameters should contain @param for each parameter, in the same @@ -1511,6 +1511,12 @@ order as the method signature.
    • Report protected methods no + + reportMissingDescription + true + Report missing @description + no + @@ -1523,6 +1529,7 @@ order as the method signature. <properties> <property name="reportPrivate" value="false" /> <property name="reportProtected" value="false" /> + <property name="reportMissingDescription" value="true" /> </properties> </rule>