diff --git a/xdoc/src/main/org/apache/maven/DescribedDependency.java b/xdoc/src/main/org/apache/maven/DescribedDependency.java index 61a5ef89..6acdd854 100644 --- a/xdoc/src/main/org/apache/maven/DescribedDependency.java +++ b/xdoc/src/main/org/apache/maven/DescribedDependency.java @@ -23,7 +23,7 @@ import org.apache.maven.project.Dependency; * Dependency wrapper. Adds an url to download and a description. * * @author Michal Maczka - * @version $Id: DescribedDependency.java,v 1.5 2004/09/21 13:47:53 brett Exp $ + * @version $Id$ */ public class DescribedDependency implements Comparable { @@ -222,4 +222,11 @@ public class DescribedDependency implements Comparable return this.getId().compareTo(other.getId()); } + + /** + * Delegate method from Dependency.getProperty("comment") + */ + public String getComment() { + return dependency.getProperty("comment"); + } } diff --git a/xdoc/src/plugin-resources/templates/dependencies.xml b/xdoc/src/plugin-resources/templates/dependencies.xml index 6427566c..8c740b0f 100644 --- a/xdoc/src/plugin-resources/templates/dependencies.xml +++ b/xdoc/src/plugin-resources/templates/dependencies.xml @@ -42,6 +42,7 @@ Type Version URL + Comment @@ -55,6 +56,11 @@ ${dep.Url} #end + + #if(${dep.comment}) + ${dep.comment} + #end + #end diff --git a/xdoc/src/plugin-test/testDependenciesComment/maven.xml b/xdoc/src/plugin-test/testDependenciesComment/maven.xml new file mode 100644 index 00000000..2a8f35da --- /dev/null +++ b/xdoc/src/plugin-test/testDependenciesComment/maven.xml @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + Checking comment for dependency dom4j + + + + Checking comment for dependency commons-jelly + + + + Checking comment for dependency velocity-dvsl + + + + + + + diff --git a/xdoc/src/plugin-test/testDependenciesComment/project.xml b/xdoc/src/plugin-test/testDependenciesComment/project.xml new file mode 100644 index 00000000..3201356d --- /dev/null +++ b/xdoc/src/plugin-test/testDependenciesComment/project.xml @@ -0,0 +1,62 @@ + + + + 3 + Test project for Maven Xdoc Plugin new feature: dependencies comment + Test for dependencies comment + Test project for Maven Xdoc Plugin new feature: dependencies comment (MPXDOC-129) + maven + test-maven-xdoc-plugin-testDependenciesComment + 1.0 + + + + + dom4j + dom4j + 1.4-dev-8 + + Simple comment + + + + + + commons-jelly + commons-jelly + 1.0-RC1 + + + + + + + + velocity-dvsl + velocity-dvsl + 0.45 + + + + + + maven-tasklist-plugin + + + diff --git a/xdoc/xdocs/changes.xml b/xdoc/xdocs/changes.xml index 7ff266fc..ac279ffe 100644 --- a/xdoc/xdocs/changes.xml +++ b/xdoc/xdocs/changes.xml @@ -27,8 +27,9 @@ + Add a comment property for dependencies Added maven.xdoc.copy.excludes property which lists the files to exclude from the resources copy. This defaults to any images currently unused by Maven. Additionally, if you are not using the classic theme, maven.xdoc.copy.excludes.classic is used to eliminate images only for the classic theme - Added new tag <escapeXml>. + Added new tag <escapeXml>. Maven xdoc plugin clean up generated velocity log as part of calling clean. New property (maven.xdoc.xml.copy) to copy only and not transform some xml files provided in the ${maven.docs.src} directory. Make compatible with Maven 1.1