Saturday 15 March 2014

documenting one or more classes out of a package with maven-javadoc-plugin -



documenting one or more classes out of a package with maven-javadoc-plugin -

i want document 2 classes package. in standard javadoc tool, like: c:> javadoc -d c:\home\html c:\home\src\java\awt\classa.java c:\home\src\java\awt\classb.java

how can in maven-javadoc-plugin?

sourcefileincludes should you're looking for.

https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#sourcefileincludes

here's example:

<plugin> <groupid>org.apache.maven.plugins</groupid> <artifactid>maven-javadoc-plugin</artifactid> <version>2.10.1</version> <configuration> <sourcefileincludes> <include>com/mycompany/myproject/myclass.java</include> </sourcefileincludes> </configuration> </plugin>

update:

i tried out on 1 of maven projects , worked @ bundle level, not on individual classes. looks these open maven issues cause:

http://jira.codehaus.org/browse/mjavadoc-388

http://jira.codehaus.org/browse/mjavadoc-365

note issue #365 related sourcefileexcludes; prepare scheduled maven-javadoc-plugin 2.11.

maven-javadoc-plugin

No comments:

Post a Comment