From 51dad5d37452908965b085244f4be0c7d26192b4 Mon Sep 17 00:00:00 2001 From: Tom Copeland Date: Wed, 3 Aug 2005 14:27:28 +0000 Subject: [PATCH] tweak to reflect symbol table being run on all source files git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@3744 51baf565-9d33-0410-a72c-fc3788e3496d --- pmd/xdocs/howitworks.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pmd/xdocs/howitworks.xml b/pmd/xdocs/howitworks.xml index b722b60203..96f2e3c034 100644 --- a/pmd/xdocs/howitworks.xml +++ b/pmd/xdocs/howitworks.xml @@ -14,9 +14,9 @@ PMD checks source code against rules and produces a report. Like this:
  • Something passes a file name and a RuleSet into PMD
  • PMD hands an InputStream to the file off to a JavaCC-generated parser
  • PMD gets a reference to an Abstract Syntax Tree back from the parser
    • -
  • 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.
    • -
  • Ditto for the data flow analysis layer, except this time it's DFA nodes that get built and attached.
    • -
  • 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.
    • +
  • PMD hands the AST off to the symbol table layer which builds scopes, finds declarations, and find usages.
    • +
  • 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.
    • +
  • 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.
  • The Report is now filled with RuleViolations, and those get printed out in XML or HTML or whatever