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

tweak to reflect symbol table being run on all source files

Browse Source 
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@3744 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Tom Copeland
2005-08-03 14:27:28 +00:00
parent de70994675
commit 51dad5d374
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
pmd/xdocs/howitworks.xml
View File

@ -14,9 +14,9 @@ PMD checks source code against rules and produces a report. Like this:
<li>Something passes a file name and a RuleSet into PMD</li>
<li>PMD hands an InputStream to the file off to a JavaCC-generated parser</li>
<li>PMD gets a reference to an Abstract Syntax Tree back from the parser</li>
<li>PMD hands the AST off to the symbol table layer if any of the rules need it. The SymbolFacade then builds a bunch of Scope nodes and attaches them to the appropriate places in the AST.</li>
<li>Ditto for the data flow analysis layer, except this time it's DFA nodes that get built and attached.</li>
<li>Each Rule in the RuleSet gets to traverse the AST and check for problems. The Rules can also poke around the symbol table and DFA nodes.</li>
<li>PMD hands the AST off to the symbol table layer which builds scopes, finds declarations, and find usages.</li>
<li>If any rules need data flow analysis, PMD hands the AST over to the DFA layer for building control flow graphs and data flow nodes.</li>
<li>Each Rule in the RuleSet gets to traverse the AST and check for problems. The rules can also poke around the symbol table and DFA nodes.</li>
<li>The Report is now filled with RuleViolations, and those get printed out in XML or HTML or whatever</li>
</ul>
</p>