You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2007/03/02 23:53:03 UTC
svn commit: r514001 - in /maven/plugins/trunk/maven-jxr-plugin/src:
main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
site/apt/examples/include-exclude.apt site/site.xml
Author: dennisl
Date: Fri Mar 2 14:53:02 2007
New Revision: 514001
URL: http://svn.apache.org/viewvc?view=rev&rev=514001
Log:
[MJXR-24] Add the ability to include/exclude source files
Added:
maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt (with props)
Modified:
maven/plugins/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java?view=diff&rev=514001&r1=514000&r2=514001
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java (original)
+++ maven/plugins/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java Fri Mar 2 14:53:02 2007
@@ -122,6 +122,22 @@
private String stylesheet;
/**
+ * A list of exclude patterns to use. By default no files are excluded.
+ *
+ * @parameter expression="${excludes}"
+ * @since 2.1
+ */
+ private ArrayList excludes;
+
+ /**
+ * A list of include patterns to use. By default all .java files are included.
+ *
+ * @parameter expression="${includes}"
+ * @since 2.1
+ */
+ private ArrayList includes;
+
+ /**
* The projects in the reactor for aggregation report.
*
* @parameter expression="${reactorProjects}"
@@ -231,6 +247,15 @@
jxr.setOutputEncoding( outputEncoding );
jxr.setRevision( "HEAD" );
jxr.setJavadocLinkDir( getJavadocLocation() );
+ // Set include/exclude patterns on the jxr instance
+ if ( excludes != null && !excludes.isEmpty() )
+ {
+ jxr.setExcludes( (String[]) excludes.toArray( new String[0] ) );
+ }
+ if ( includes != null && !includes.isEmpty() )
+ {
+ jxr.setIncludes( (String[]) includes.toArray( new String[0] ) );
+ }
jxr.xref( sourceDirs, templateDir, windowTitle, docTitle, getBottomText( project.getInceptionYear() ) );
Added: maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt?view=auto&rev=514001
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt (added)
+++ maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt Fri Mar 2 14:53:02 2007
@@ -0,0 +1,73 @@
+ ------
+ Including/Excluding Source Files
+ ------
+ Dennis Lundberg
+ ------
+ 2 March 2007
+ ------
+
+Including/Excluding Source Files
+
+ To include or exclude files from the generated JXR files, you need to
+ configure the JXR plugin in your <<<pom.xml>>>. This is done using patterns
+ similar to those used in Ant.
+
+*Including files
+
+ The default is to include all java files. The pattern <<<**/*.java>>> is used
+ to achieve this. If you want to use a different pattern you just configure it
+ in your pom.xml like this:
+
++-----+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ ...
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ <configuration>
+ ...
+ <includes>
+ <include>**/include/*.java</include>
+ <includes>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </reporting>
+ ...
+</project>
++-----+
+
+*Excluding files
+
+ By default no files are excluded. You can exclude files by configuring your
+ pom.xml. If you want to exclude all your abstract classes a configuration
+ like this might be useful:
+
++-----+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ ...
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ <configuration>
+ ...
+ <excludes>
+ <exclude>**/Abstract*.java</exclude>
+ </excludes>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </reporting>
+ ...
+</project>
++-----+
Propchange: maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt
------------------------------------------------------------------------------
svn:eol-style = native
Modified: maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml?view=diff&rev=514001&r1=514000&r2=514001
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml Fri Mar 2 14:53:02 2007
@@ -27,6 +27,7 @@
</menu>
<menu name="Examples">
<item name="Aggregating JXR Reports for Multi-Projects" href="/examples/aggregate.html"/>
+ <item name="Including/Excluding Source Files" href="/examples/include-exclude.html"/>
<item name="Linking JXR Files to Javadocs" href="/examples/linkjavadoc.html"/>
<item name="JXR Sample Report" href="/xref/index.html"/>
</menu>