cvs commit: maven/src/plugins-build/findbugs .cvsignore

[bw...@apache.org]

bwalding    2003/08/29 15:12:56

  Added:       src/plugins-build/findbugs/xdocs index.xml goals.xml
                        changes.xml properties.xml navigation.xml
               src/plugins-build/findbugs .cvsignore
  Log:
  Documentation for the plugin
  
  Revision  Changes    Path
  1.1                  maven/src/plugins-build/findbugs/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <title>Maven FindBugs Plug-in</title>
      <author email="bwalding@apache.org">Ben Walding</author>
    </properties>
  
    <body>
      <section name="Maven FindBugs Plug-in">
        <p>
          FindBugs is a program to find bugs in Java programs. 
          It looks for instances of "bug patterns" --- 
          code instances that are likely to be errors.
        </p>
        <p>
          The plugin executes the FindBugs program against your code and
          generates a report similar to CheckStyle.
        </p>
        <p>
          Currently this report is display in the console window, but will
          ultimately be integrated into the site.
        </p>
      </section>
   </body>
  </document>
  
  
  
  1.1                  maven/src/plugins-build/findbugs/xdocs/goals.xml
  
  Index: goals.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <document>
  
    <properties>
      <title>FindBugs Plugin Goals</title>
      <author email="jstrachan@apache.org">James Strachan</author>
    </properties>
  
    <body>
      <section name="Goals">
        <table>
        	<tr><th>Goal</th><th>Description</th></tr>
        	<tr>
        	  <td>maven-findbugs-plugin:report</td>
        	  <td>
        	    This scans your compiled code, applies a set of bug pattern detection
  			rules, then produces a report in xdoc format (only generates to console at present).
        	  </td>
        	</tr>
        </table>
      </section>
    </body>
  </document>
  
  
  
  1.1                  maven/src/plugins-build/findbugs/xdocs/changes.xml
  
  Index: changes.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
    <properties>
      <title>Changes</title>
      <author email="bwalding@apache.org">Ben Walding</author>
    </properties>
  
    <body>
      
    </body>
  </document>
  
  
  
  
  1.1                  maven/src/plugins-build/findbugs/xdocs/properties.xml
  
  Index: properties.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <document>
  
    <properties>
      <title>FindBugs Properties</title>
      <author email="bwalding@apache.org">Ben Walding</author>
    </properties>
  
    <body>
      <section name="Plugin Settings"> 
        <table>
          <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
          
        </table>
      </section>
    </body>
  </document>
  
  
  
  1.1                  maven/src/plugins-build/findbugs/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <project name="Maven FAQ Plugin">
  
    <title>Maven FAQ Plugin</title>
  
    <body>
      <links>
        <item name="Maven"    href="http://maven.apache.org/"/>
        <item name="FindBugs"    href="http://www.cs.umd.edu/~pugh/java/bugs/"/>
      </links>
      <menu name="Overview">
        <item name="Index"                   href="/index.html" />
        <item name="Goals"                   href="/goals.html" />
        <item name="Properties"              href="/properties.html" />
      </menu>
    </body>
  </project>
  
  
  
  1.1                  maven/src/plugins-build/findbugs/.cvsignore
  
  Index: .cvsignore
  ===================================================================
  target
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org