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

Update documentation

Browse Source 
TRAVIS_JOB_NUMBER=4530.2
TRAVIS_COMMIT_RANGE=baeda3cfe5aa...3e01cb443109
This commit is contained in:
Travis CI (pmd-bot)
2019-12-18 09:23:39 +00:00
parent bbcc353e22
commit 3651e14597
112 changed files with 364 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
404.html
View File

@ -1346,7 +1346,7 @@ $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

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>Tue, 17 Dec 2019 17:01:20 +0000</pubDate>
<lastBuildDate>Tue, 17 Dec 2019 17:01:20 +0000</lastBuildDate>
<pubDate>Wed, 18 Dec 2019 09:23:04 +0000</pubDate>
<lastBuildDate>Wed, 18 Dec 2019 09:23:04 +0000</lastBuildDate>
<generator>Jekyll v3.8.5</generator>
</channel>

2
index.html
View File

@ -6040,7 +6040,7 @@ $('#filter a').click(function (e) {
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> August 2017<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> August 2017<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
js/mydoc_scroll.html
View File

@ -1580,7 +1580,7 @@ $('#small-box-links').localScroll({
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> November 30, 2015<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> November 30, 2015<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
license.html
View File

@ -1590,7 +1590,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
news.html
View File

@ -1341,7 +1341,7 @@
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
news_archive.html
View File

@ -1342,7 +1342,7 @@
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_about_help.html
View File

@ -1366,7 +1366,7 @@ through the archives (<a href="http://java-pmd.30631.n5.nabble.com/">archive1</a
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> September 2017<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> September 2017<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_apex_metrics_index.html
View File

@ -1420,7 +1420,7 @@ flow statement.</li>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> July 20, 2017<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> July 20, 2017<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_building.html
View File

@ -1436,7 +1436,7 @@ please post <a href="http://sourceforge.net/p/pmd/discussion/188192">here</a> an
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_development.html
View File

@ -1384,7 +1384,7 @@ every push. Each pull request is built as well.</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> August 2017<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> August 2017<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_how_pmd_works.html
View File

@ -1400,7 +1400,7 @@ type resolution information and DFA nodes.</li>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> September 2017<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> September 2017<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_major_adding_new_cpd_language.html
View File

@ -1430,7 +1430,7 @@ $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> March 18, 2019 (6.13.0)<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> March 18, 2019 (6.13.0)<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

25
pmd_devdocs_major_adding_new_language.html
View File

@ -1356,9 +1356,9 @@ $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3
<h2 id="4--compile-your-parser-if-using-jjt">4. Compile your parser (if using JJT)</h2>
<ul>
<li>An ant script is being used to compile jjt files into classes. This is in alljavacc.xml file.</li>
<li>In the file, create a new target for your language. Use vmjjtree or javajjtree as an example.</li>
<li>Inside the alljavacctarget, add your new target to the “depends” list just before cleanup</li>
<li>An ant script is being used to compile jjt files into classes. This is in <code class="highlighter-rouge">pmd-&lt;lang&gt;/src/main/ant/alljavacc.xml</code> file.</li>
<li>Create <code class="highlighter-rouge">alljavacc.xml</code> file for your language, you can use one from <code class="highlighter-rouge">pmd-java</code> as an example.</li>
<li>You would probably want to adjust contents of the <code class="highlighter-rouge">&lt;delete&gt;</code> tag: start with an empty <code class="highlighter-rouge">&lt;fileset&gt;</code> and add there <code class="highlighter-rouge">&lt;include&gt;</code>s for those AST nodes you had to manually rewrite (moving those node classes from autogenerated directory to the regular source tree).</li>
</ul>
<h2 id="5--create-a-tokenmanager">5. Create a TokenManager</h2>
@ -1452,6 +1452,23 @@ This will load all rulesets and verify, that all required attributes are provide
</li>
</ul>
<h2 id="debugging-with-rule-designer">Debugging with Rule Designer</h2>
<p>When implementing your grammar it may be very useful to see how PMD parses your example files.
This can be achieved with Rule Designer:</p>
<ul>
<li>Override the <code class="highlighter-rouge">getXPathNodeName</code> in your AST nodes for Designer to show node names.</li>
<li>Make sure to override both <code class="highlighter-rouge">jjtOpen</code> and <code class="highlighter-rouge">jjtClose</code> in your AST node base class so that they set both start and end line and column for proper node bound highlighting.</li>
<li><em>Not strictly required but trivial and useful:</em> implement syntax highlighting for Rule Designer:
<ul>
<li>Fork and clone the <a href="https://github.com/pmd/pmd-designer">pmd/pmd-designer</a> repository.</li>
<li>Add a syntax highlighter implementation to <code class="highlighter-rouge">net.sourceforge.pmd.util.fxdesigner.util.codearea.syntaxhighlighting</code> (you could use Java as an example).</li>
<li>Register it in the <code class="highlighter-rouge">AvailableSyntaxHighlighters</code> enumeration.</li>
<li>Now build your implementation and place the <code class="highlighter-rouge">target/pmd-ui-&lt;version&gt;-SNAPSHOT.jar</code> to the <code class="highlighter-rouge">lib</code> directory inside your <code class="highlighter-rouge">pmd-bin-...</code> distribution (you have to delete old <code class="highlighter-rouge">pmd-ui-*.jar</code> from there).</li>
</ul>
</li>
</ul>
<div class="tags">
@ -1479,7 +1496,7 @@ This will load all rulesets and verify, that all required attributes are provide
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> July 3, 2016<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> October 5, 2019<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_major_adding_new_metrics_framework.html
View File

@ -1462,7 +1462,7 @@ build a <code class="highlighter-rouge">Signature&lt;N&gt;</code> from a <code c
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> December 2017<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> December 2017<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_pmdtester.html
View File

@ -1368,7 +1368,7 @@ Regression difference reports are commented back to the PR for the reviewer’s
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_roadmap.html
View File

@ -1489,7 +1489,7 @@ This should be configurable on per Rule basis similar to TR and SymbolTable.</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_rule_deprecation_policy.html
View File

@ -1458,7 +1458,7 @@ major release of PMD.</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> November 15, 2019<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> November 15, 2019<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_devdocs_writing_documentation.html
View File

@ -1605,7 +1605,7 @@ by specifying <code class="highlighter-rouge">-Dpmd.doc.checkExternalLinks=true<
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_java_metrics_index.html
View File

@ -1699,7 +1699,7 @@ In Proceedings ACM Symposium on Software Reusability, 1995.</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> July 20, 2017<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> July 20, 2017<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_languages_jsp.html
View File

@ -1399,7 +1399,7 @@ contains only “.java” files, JSP files obviously will not be checked.</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_next_major_development.html
View File

@ -2040,7 +2040,7 @@ will be removed with PMD 7.0.0. The rule is replaced by the more general
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_projectdocs_committers_merging_pull_requests.html
View File

@ -1517,7 +1517,7 @@ integrated (e.g. gitk and github show the branches, from which the specific comm
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
<span>Page last updated:</span> August 2017<br/> Site last generated: Dec 17, 2019 <br />
<span>Page last updated:</span> August 2017<br/> Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_projectdocs_committers_releasing.html
View File

@ -1555,7 +1555,7 @@ and <code class="highlighter-rouge">mvn versions:set -DnewVersion=5.7.0-SNAPSHOT
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_projectdocs_credits.html
View File

@ -1860,7 +1860,7 @@ PMD scoreboard formulas, pmd-dcpd optimizations</li>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_projectdocs_faq.html
View File

@ -1393,7 +1393,7 @@ You must take this into account for certain rules.</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_projectdocs_trivia_meaning.html
View File

@ -1362,7 +1362,7 @@ really know. We just think the letters sound good together.</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_projectdocs_trivia_news.html
View File

@ -1482,7 +1482,7 @@ interview with Ole-Martin and Tom</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_projectdocs_trivia_products.html
View File

@ -1410,7 +1410,7 @@ to catch web app security problems. Thanks to Joseph Hemler for the props!</p>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

2
pmd_projectdocs_trivia_similarprojects.html
View File

@ -1417,7 +1417,7 @@ only for maven project.</li>
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Dec 17, 2019 <br />
Site last generated: Dec 18, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>

Some files were not shown because too many files have changed in this diff Show More