Maven Javadoc Plugin
  1. Maven Javadoc Plugin
  2. MJAVADOC-78

Add a flag to provide standard doclet parameters to custom ones too

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0
    • Fix Version/s: 2.5
    • Labels:
      None

      Description

      I'm working on a custom doclet that wraps the standard doclet and add extra behaviour (automated class diagram generation in class javadocs and package javadocs). I want to run it under maven 2, but I've stumbled against the default behaviour: standard doclet parameters such as -link are provided only if the javadoc is the standard one (in AbstractJavadocMojo.java, the check is "if ( StringUtils.isEmpty( doclet ) ) ...").

      A generally good behaviour would be not perform assumptions, but to call XXXDoclet.optionLength for each parameter, and see if the doclet accepts them or not (and thus provide only the one accepted). As an alternative, add at least a flag to allow the provision of the standard doclet parameters to the custom ones as well.

      1. JAVADOC-78.patch
        2 kB
        Siveton Vincent
      2. pom.xml
        31 kB
        Andrea Aime

        Activity

        Andrea Aime created issue -
        Siveton Vincent made changes -
        Field Original Value New Value
        Attachment JAVADOC-78.patch [ 35052 ]
        Andrea Aime made changes -
        Attachment pom.xml [ 35075 ]
        Siveton Vincent made changes -
        Fix Version/s 2.5 [ 14120 ]
        Siveton Vincent made changes -
        Assignee Vincent Siveton [ siveton ]
        Status Open [ 1 ] Closed [ 6 ]
        Resolution Fixed [ 1 ]
        Mark Thomas made changes -
        Project Import Sun Apr 05 11:56:47 UTC 2015 [ 1428235007093 ]
        Mark Thomas made changes -
        Workflow jira [ 12722315 ] Default workflow, editable Closed status [ 12762530 ]
        Mark Thomas made changes -
        Project Import Mon Apr 06 00:11:46 UTC 2015 [ 1428279106587 ]
        Mark Thomas made changes -
        Workflow jira [ 12959865 ] Default workflow, editable Closed status [ 12996594 ]

          People

          • Assignee:
            Siveton Vincent
            Reporter:
            Andrea Aime
          • Votes:
            3 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development