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 2008/05/18 12:43:44 UTC
svn commit: r657534 - in /maven/plugins/trunk/maven-docck-plugin/src:
main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
site/apt/usage.apt
Author: dennisl
Date: Sun May 18 03:43:44 2008
New Revision: 657534
URL: http://svn.apache.org/viewvc?rev=657534&view=rev
Log:
[MDOCCK-11] Add support for Velocity filtered documents
Modified:
maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt
Modified: maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java?rev=657534&r1=657533&r2=657534&view=diff
==============================================================================
--- maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java (original)
+++ maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java Sun May 18 03:43:44 2008
@@ -547,9 +547,13 @@
fs.setFollowSymlinks( false );
fs.addInclude( "apt/" + pattern + ".apt" );
+ fs.addInclude( "apt/" + pattern + ".apt.vm" );
fs.addInclude( "xdoc/" + pattern + ".xml" );
+ fs.addInclude( "xdoc/" + pattern + ".xml.vm" );
fs.addInclude( "fml/" + pattern + ".fml" );
+ fs.addInclude( "fml/" + pattern + ".fml.vm" );
fs.addInclude( "resources/" + pattern + ".html" );
+ fs.addInclude( "resources/" + pattern + ".html.vm" );
String[] includedFiles = fileSetManager.getIncludedFiles( fs );
Modified: maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java?rev=657534&r1=657533&r2=657534&view=diff
==============================================================================
--- maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java (original)
+++ maven/plugins/trunk/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java Sun May 18 03:43:44 2008
@@ -175,30 +175,30 @@
}
}
- // check for index.(apt|html|xml)
+ // check for index.(apt|html|xml)[.vm]
if ( !findFiles( projectSiteDirectory, "index" ) )
{
- reporter.error( "There is no \'index\' file in your site directory (in apt|html|xml format)." );
+ reporter.error( "There is no \'index\' file in your site directory (in apt|html|xml[.vm] format)." );
}
- // check for usage.(apt|html|xml)
+ // check for usage.(apt|html|xml)[.vm]
if ( !findFiles( projectSiteDirectory, "usage" ) )
{
- reporter.error( "There is no \'usage\' file in your site directory (in apt|html|xml format)." );
+ reporter.error( "There is no \'usage\' file in your site directory (in apt|html|xml[.vm] format)." );
}
- // check for **/examples/**.(apt|html|xml) or **/example*.(apt|html|xml)
+ // check for **/examples/**.(apt|html|xml)[.vm] or **/example*.(apt|html|xml)[.vm]
if ( !findFiles( projectSiteDirectory, "**/examples/*" )
&& !findFiles( projectSiteDirectory, "**/example*" ) )
{
- reporter.error( "There are no example files in your site directory (in apt|html|xml format)."
- + " They should either be called \'example*.(apt|html|xml)\'"
+ reporter.error( "There are no example files in your site directory (in apt|html|xml[.vm] format)."
+ + " They should either be called \'example*.(apt|html|xml)[.vm]\'"
+ " or they should be located in the \'examples\' directory." );
}
if ( !findFiles( projectSiteDirectory, "faq" ) )
{
- reporter.error( "There is no \'faq\' file in your site directory (in apt|fml|html|xml format)." );
+ reporter.error( "There is no \'faq\' file in your site directory (in apt|fml|html|xml[.vm] format)." );
}
}
Modified: maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt?rev=657534&r1=657533&r2=657534&view=diff
==============================================================================
--- maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt Sun May 18 03:43:44 2008
@@ -119,8 +119,8 @@
[ERROR] The following documentation problems were found:
o Maven Documentation Checker Plugin (3 errors)
- [ERROR] There is no 'index' file in your site directory (in apt|html|xml format).
- [ERROR] There are no example files in your site directory (in apt|html|xml format). They should either be called 'example*.(apt|html|xml)' or they should be located in the 'examples' directory.
+ [ERROR] There is no 'index' file in your site directory (in apt|html|xml[.vm] format).
+ [ERROR] There are no example files in your site directory (in apt|html|xml[.vm] format). They should either be called 'example*.(apt|html|xml)[.vm]' or they should be located in the 'examples' directory.
[ERROR] Parameter: 'mojoParameter' in mojo: 'check' is missing a description.
[INFO] ------------------------------------------------------------------------