hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Update documentation

Browse Source 
https://github.com/pmd/pmd/actions/runs/1373131798
e1d4a29e94...e67f2a0400
This commit is contained in:
PMD CI (pmd-bot)
2021-10-22 17:31:13 +00:00
parent b36228ea97
commit 087c0a3b9f
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
feed.xml
View File

@ -5,8 +5,8 @@
<description>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.</description>
<link>https://pmd.github.io/pmd/</link>
<atom:link href="https://pmd.github.io/pmd/feed.xml" rel="self" type="application/rss+xml"/>
<pubDate>Fri, 22 Oct 2021 17:21:56 +0000</pubDate>
<lastBuildDate>Fri, 22 Oct 2021 17:21:56 +0000</lastBuildDate>
<pubDate>Fri, 22 Oct 2021 17:28:17 +0000</pubDate>
<lastBuildDate>Fri, 22 Oct 2021 17:28:17 +0000</lastBuildDate>
<generator>Jekyll v3.9.0</generator>
</channel>

9
pmd_rules_apex_documentation.html
View File

@ -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).</li>
<li>ApexDoc comments are present for classes, methods, and properties that are protected or private, depending
on the properties <code class="language-plaintext highlighter-rouge">reportPrivate</code> and <code class="language-plaintext highlighter-rouge">reportProtected</code>.</li>
<li>ApexDoc comments should contain @description.</li>
<li>ApexDoc comments should contain @description depending on the property ‘reportMissingDescription’.</li>
<li>ApexDoc comments on non-void, non-constructor methods should contain @return.</li>
<li>ApexDoc comments on void or constructor methods should not contain @return.</li>
<li>ApexDoc comments on methods with parameters should contain @param for each parameter, in the same
@ -1511,6 +1511,12 @@ order as the method signature.</li>
<td>Report protected methods</td>
<td>no</td>
</tr>
<tr>
<td>reportMissingDescription</td>
<td>true</td>
<td>Report missing @description</td>
<td>no</td>
</tr>
</tbody>
</table>
@ -1523,6 +1529,7 @@ order as the method signature.</li>
<span class="nt">&lt;properties&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"reportPrivate"</span> <span class="na">value=</span><span class="s">"false"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"reportProtected"</span> <span class="na">value=</span><span class="s">"false"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"reportMissingDescription"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/properties&gt;</span>
<span class="nt">&lt;/rule&gt;</span>
</code></pre></div></div>