[jira] [Commented] (MJAVADOC-744) Maven coordinates in Javadoc
[ https://issues.apache.org/jira/browse/MJAVADOC-744?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17790558#comment-17790558 ] Peter Verhas commented on MJAVADOC-744: --- You suggest using a special Doclet integrated with the Maven JavaDoc plugin. Such Doclet will only be usable for projects that use Maven as a build tool. If you want to include the Maven coordinated into the JavaDoc, the header and the footer configuration parameters are the tools for that. You can write the maven coordinates or whatever you want to be included on all pages. Suppose you want to get the maven coordinates or some other information already available somewhere to get there automated. In that case, you can use the Jamal Maven Extension and maintain a `pom.jam` file. With that you can use macros that fetch the coordinates automatically from the pom.xml file. > Maven coordinates in Javadoc > > > Key: MJAVADOC-744 > URL: https://issues.apache.org/jira/browse/MJAVADOC-744 > Project: Maven Javadoc Plugin > Issue Type: New Feature >Reporter: Elliotte Rusty Harold >Priority: Minor > > Add an option to the javadoc plugin to include the Maven coordinates > (group:artifact:version) of a class in its Javadoc. > I noticed this morning for about the 173rd time that I could google for the > API doc of a class I needed, but still couldn't figure out which artifact I > needed to add to my pom.xml to include that class in my project. -- This message was sent by Atlassian Jira (v8.20.10#820010)
[jira] [Commented] (MJAVADOC-744) Maven coordinates in Javadoc
[ https://issues.apache.org/jira/browse/MJAVADOC-744?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17790553#comment-17790553 ] Elliotte Rusty Harold commented on MJAVADOC-744: Might require a custom doclet. The javadoc tool doesn't know about this since these coordinates aren't in .java files. It needs to come from the javadoc plugi, which is going to be tricky since we'd need to inject something into the javadoc generation process. > Maven coordinates in Javadoc > > > Key: MJAVADOC-744 > URL: https://issues.apache.org/jira/browse/MJAVADOC-744 > Project: Maven Javadoc Plugin > Issue Type: New Feature >Reporter: Elliotte Rusty Harold >Priority: Minor > > Add an option to the javadoc plugin to include the Maven coordinates > (group:artifact:version) of a class in its Javadoc. > I noticed this morning for about the 173rd time that I could google for the > API doc of a class I needed, but still couldn't figure out which artifact I > needed to add to my pom.xml to include that class in my project. -- This message was sent by Atlassian Jira (v8.20.10#820010)
[jira] [Commented] (MJAVADOC-744) Maven coordinates in Javadoc
[ https://issues.apache.org/jira/browse/MJAVADOC-744?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17693257#comment-17693257 ] Elliotte Rusty Harold commented on MJAVADOC-744: I'm not sure either is quite right. I'm thinking it would be a nice if there were text in the class comment saying something like, ``` org.apache.commons:commons-lang3:3.12.0 org.apache.commons.lang3 Class StringUtils ``` Or something like that. I'm not sure exactly where this belongs, but it would be nice to have on the page. > Maven coordinates in Javadoc > > > Key: MJAVADOC-744 > URL: https://issues.apache.org/jira/browse/MJAVADOC-744 > Project: Maven Javadoc Plugin > Issue Type: New Feature >Reporter: Elliotte Rusty Harold >Priority: Minor > > Add an option to the javadoc plugin to include the Maven coordinates > (group:artifact:version) of a class in its Javadoc. > I noticed this morning for about the 173rd time that I could google for the > API doc of a class I needed, but still couldn't figure out which artifact I > needed to add to my pom.xml to include that class in my project. -- This message was sent by Atlassian Jira (v8.20.10#820010)
[jira] [Commented] (MJAVADOC-744) Maven coordinates in Javadoc
[ https://issues.apache.org/jira/browse/MJAVADOC-744?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17693256#comment-17693256 ] Peter Verhas commented on MJAVADOC-744: --- I think the option you are looking for is called `header` and `footer`. String - Specifies the header text to be placed at the top of each output file. See also: Doclet option header. User property is: header. String - Specifies the footer text to be placed at the bottom of each output file. See also: Doclet option footer. User property is: footer. > Maven coordinates in Javadoc > > > Key: MJAVADOC-744 > URL: https://issues.apache.org/jira/browse/MJAVADOC-744 > Project: Maven Javadoc Plugin > Issue Type: New Feature >Reporter: Elliotte Rusty Harold >Priority: Minor > > Add an option to the javadoc plugin to include the Maven coordinates > (group:artifact:version) of a class in its Javadoc. > I noticed this morning for about the 173rd time that I could google for the > API doc of a class I needed, but still couldn't figure out which artifact I > needed to add to my pom.xml to include that class in my project. -- This message was sent by Atlassian Jira (v8.20.10#820010)
