phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
https://github.com/pmd/pmd/actions/runs/2034657190
3d72a0dcd7...44e779ce13
This commit is contained in:
PMD CI (pmd-bot) 2022-03-24 14:15:12 +00:00
parent cca1f07bd3
commit a19efe909d
3 changed files with 23 additions and 6 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>Thu, 24 Mar 2022 11:40:20 +0000</pubDate>
<lastBuildDate>Thu, 24 Mar 2022 11:40:20 +0000</lastBuildDate>
<pubDate>Thu, 24 Mar 2022 14:12:15 +0000</pubDate>
<lastBuildDate>Thu, 24 Mar 2022 14:12:15 +0000</lastBuildDate>
<generator>Jekyll v3.9.0</generator>
</channel>

15
pmd_release_notes.html
View File

@ -1481,6 +1481,11 @@ The CLI itself remains compatible, if you run PMD via command-line, no action is
<h3 id="fixed-issues">Fixed Issues</h3>
<ul>
<li>apex
<ul>
<li><a href="https://github.com/pmd/pmd/pull/3817">#3817</a>: [apex] Add designer bindings to display main attributes</li>
</ul>
</li>
<li>apex-performance
<ul>
<li><a href="https://github.com/pmd/pmd/pull/3773">#3773</a>: [apex] EagerlyLoadedDescribeSObjectResult false positives with SObjectField.getDescribe()</li>
@ -1520,9 +1525,15 @@ in favour of <a href="https://docs.pmd-code.org/apidocs/pmd-core/6.44.0-SNAPSHOT
<a href="https://docs.pmd-code.org/apidocs/pmd-core/6.44.0-SNAPSHOT/net/sourceforge/pmd/PMDConfiguration.html#addRuleSet(java.lang.String)"><code>addRuleSet</code></a>,
and <a href="https://docs.pmd-code.org/apidocs/pmd-core/6.44.0-SNAPSHOT/net/sourceforge/pmd/PMDConfiguration.html#getRuleSetPaths()"><code>getRuleSetPaths</code></a>.</li>
<li>Several members of <a href="https://docs.pmd-code.org/apidocs/pmd-test/6.44.0-SNAPSHOT/net/sourceforge/pmd/cli/BaseCLITest.html#"><code>BaseCLITest</code></a> have been deprecated with replacements.</li>
<li>Several members of <a href="https://docs.pmd-code.org/apidocs/pmd-core/6.44.0-SNAPSHOT/net/sourceforge/pmd/cli/PMDCommandLineInterface.html#"><code>PMDCommandLineInterface</code></a> have been explicitly deprecated.
<li>
<p>Several members of <a href="https://docs.pmd-code.org/apidocs/pmd-core/6.44.0-SNAPSHOT/net/sourceforge/pmd/cli/PMDCommandLineInterface.html#"><code>PMDCommandLineInterface</code></a> have been explicitly deprecated.
The whole class however was deprecated long ago already with 6.30.0. It is internal API and should
not be used.</li>
not be used.</p>
</li>
<li>In modelica, the rule classes <a href="https://docs.pmd-code.org/apidocs/pmd-modelica/6.44.0-SNAPSHOT/net/sourceforge/pmd/lang/modelica/rule/AmbiguousResolutionRule.html#"><code>AmbiguousResolutionRule</code></a>
and <a href="https://docs.pmd-code.org/apidocs/pmd-modelica/6.44.0-SNAPSHOT/net/sourceforge/pmd/lang/modelica/rule/ConnectUsingNonConnector.html#"><code>ConnectUsingNonConnector</code></a> have been deprecated,
since they didn’t comply to the usual rule class naming conventions yet.
The replacements are in the subpackage <code class="language-plaintext highlighter-rouge">bestpractices</code>.</li>
</ul>
<h4 id="experimental-apis">Experimental APIs</h4>

10
pmd_rules_modelica_bestpractices.html
View File

@ -1442,12 +1442,14 @@
<!-- DO NOT EDIT THIS FILE. This file is generated from file ../pmd-modelica/src/main/resources/category/modelica/bestpractices.xml. -->
<h2 id="ambiguousresolution">AmbiguousResolution</h2>
<p><strong>Since:</strong> PMD 6.21.0</p>
<p><strong>Priority:</strong> Medium (3)</p>
<p>There is multiple candidates for this type resolution. While generally this is not an error,
this may indicate a bug.</p>
<p><strong>This rule is defined by the following Java class:</strong> <a href="https://github.com/pmd/pmd/blob/master/pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/rule/AmbiguousResolutionRule.java">net.sourceforge.pmd.lang.modelica.rule.AmbiguousResolutionRule</a></p>
<p><strong>This rule is defined by the following Java class:</strong> <a href="https://github.com/pmd/pmd/blob/master/pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/rule/bestpractices/AmbiguousResolutionRule.java">net.sourceforge.pmd.lang.modelica.rule.bestpractices.AmbiguousResolutionRule</a></p>
<p><strong>Example(s):</strong></p>
@ -1478,6 +1480,8 @@ end Test;
<h2 id="classstartnameequalsendname">ClassStartNameEqualsEndName</h2>
<p><strong>Since:</strong> PMD 6.21.0</p>
<p><strong>Priority:</strong> High (1)</p>
<p>Having a class starting with some name and some <em>different</em>
@ -1502,12 +1506,14 @@ end SomeOtherName /* should be SomeName */;
<h2 id="connectusingnonconnector">ConnectUsingNonConnector</h2>
<p><strong>Since:</strong> PMD 6.21.0</p>
<p><strong>Priority:</strong> Medium High (2)</p>
<p>Modelica specification requires passing connectors to the <code class="language-plaintext highlighter-rouge">connect</code> clause,
while some implementations tolerate using it on plain variables, etc..</p>
<p><strong>This rule is defined by the following Java class:</strong> <a href="https://github.com/pmd/pmd/blob/master/pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/rule/ConnectUsingNonConnector.java">net.sourceforge.pmd.lang.modelica.rule.ConnectUsingNonConnector</a></p>
<p><strong>This rule is defined by the following Java class:</strong> <a href="https://github.com/pmd/pmd/blob/master/pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/rule/bestpractices/ConnectUsingNonConnectorRule.java">net.sourceforge.pmd.lang.modelica.rule.bestpractices.ConnectUsingNonConnectorRule</a></p>
<p><strong>Example(s):</strong></p>