Maven JXR
  1. Maven JXR
  2. JXR-35

Review and revise plugin documentation

    Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0
    • Fix Version/s: 2.1
    • Component/s: maven2 jxr plugin
    • Labels:
      None
    • Number of attachments :
      0

      Activity

      Hide
      Maria Odea Ching added a comment -

      Changes made in the plugin documentation:

      • Javadocs
      • APTs: index, usage, examples
      • required tags for docck in the plugin's pom.xml
      • FAQ page

      The plugin docs are now ready for review

      Show
      Maria Odea Ching added a comment - Changes made in the plugin documentation: Javadocs APTs: index, usage, examples required tags for docck in the plugin's pom.xml FAQ page The plugin docs are now ready for review
      Hide
      Brett Porter added a comment -
      • goal links incorrect on front page
      • usage indenting seems a bit more than usual 2 spaces
      • use "mvn site" instead of site:site, and don't refer to "m2" on usage guide
      • on usage guide, you do not need to put the jxr plugin into the pom at all to generate from the command line (and doing so from reporting is sufficient and recommended). I'd remove the pom sample and just leave the commands.
      • remove FAQ/comment out from nav (the only question is answered on the front page already
      • remove the output directories for javadoc in the pom example (hardcoded paths are a bad example to set). I'd just refer to needing to specify the javadoc plugin in the reporting section, and that if you customise the destdir then you need to customise the javadocdir in jxr
      • suggest removing the example xref and just linking to the actual one for the plugin.

      thanks!

      Show
      Brett Porter added a comment - goal links incorrect on front page usage indenting seems a bit more than usual 2 spaces use "mvn site" instead of site:site, and don't refer to "m2" on usage guide on usage guide, you do not need to put the jxr plugin into the pom at all to generate from the command line (and doing so from reporting is sufficient and recommended). I'd remove the pom sample and just leave the commands. remove FAQ/comment out from nav (the only question is answered on the front page already remove the output directories for javadoc in the pom example (hardcoded paths are a bad example to set). I'd just refer to needing to specify the javadoc plugin in the reporting section, and that if you customise the destdir then you need to customise the javadocdir in jxr suggest removing the example xref and just linking to the actual one for the plugin. thanks!
      Hide
      Maria Odea Ching added a comment -

      Revised the docs and applied the comments from above. Thanks

      Show
      Maria Odea Ching added a comment - Revised the docs and applied the comments from above. Thanks
      Hide
      Brett Porter added a comment -

      looks good to me

      Show
      Brett Porter added a comment - looks good to me

        People

        • Assignee:
          Maria Odea Ching
          Reporter:
          Maria Odea Ching
        • Votes:
          0 Vote for this issue
          Watchers:
          0 Start watching this issue

          Dates

          • Due:
            Created:
            Updated:
            Resolved:

            Time Tracking

            Estimated:
            Original Estimate - 12 hours
            12h
            Remaining:
            Time Spent - 10 hours, 15 minutes Remaining Estimate - 1 hour, 45 minutes
            1h 45m
            Logged:
            Time Spent - 10 hours, 15 minutes Remaining Estimate - 1 hour, 45 minutes
            10h 15m