[jboss-jira] [JBoss JIRA] Commented: (JBBUILD-639) Configure maven-javadoc-plugin

[Paul Gier (JIRA)]

    [ https://jira.jboss.org/browse/JBBUILD-639?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12542293#action_12542293 ] 

Paul Gier commented on JBBUILD-639:
-----------------------------------

detectJavaApiLink - Is the default not working correctly for this one?  It should put a link matching the compile source version.
doctitle - The default is "${project.name} ${project.version} API".  Is there a reason to remove API from the title?
bottom - The only change I see in this one compared to the default is removing the project inception date, is there a reason for this?

I would prefer to leave the APIViz configuration up to the individual projects in case some projects don't want this.

> Configure maven-javadoc-plugin
> ------------------------------
>
>                 Key: JBBUILD-639
>                 URL: https://jira.jboss.org/browse/JBBUILD-639
>             Project: JBoss Build System
>          Issue Type: Feature Request
>          Components: JBoss Parent POM
>    Affects Versions: JBoss Parent POM - 5
>            Reporter: David Lloyd
>            Assignee: Paul Gier
>             Fix For:  JBoss Parent POM - 6
>
>
> There's some default config we could apply to the javadoc plugin:
>             <plugin>
>                 <artifactId>maven-javadoc-plugin</artifactId>
>                 <configuration>
>                     <detectJavaApiLink>false</detectJavaApiLink>
>                     <doctitle>${project.name} ${project.version}</doctitle>
>                     <header>${project.name} ${project.version}</header>
>                     <footer>${project.name} ${project.version}</footer>
>                     <bottom><![CDATA[<i>Copyright &#169; 2010 JBoss, a division of Red Hat, Inc.</i>]]></bottom>
>                     <links>
>                         <link>http://java.sun.com/javase/6/docs/api/</link>
>                     </links>
>                 </configuration>
>             </plugin>
> If there's some way to replace "2010" with the current year, that'd be great as well.
> In addition there's a doclet we should probably be using:
>                     <doclet>net.gleamynode.apiviz.APIviz</doclet>
>                     <docletArtifact>
>                         <groupId>org.jboss.apiviz</groupId>
>                         <artifactId>apiviz</artifactId>
>                         <version>1.3.1.GA</version>
>                     </docletArtifact>
> Though this may slow down javadoc generation, so it's more of a "maybe" kind of thing.
> Thanks.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira