Create aggregated Javadocs

• Key: STR-2839
• Type: Improvement
• Status: Closed
• Resolution: Fixed
• Priority: Major
• Assignee: Paul Benedict
• Reporter: Don Brown
• Component/s: Build
• Affects Version/s: 1.3.5
• Fix Version/s: 1.3.6

Description

The javadocs in our release build should aggregate all the artifacts

Comments

[Wendy Smoak]

Adding <aggregate>true</aggregate> to the javadoc plugin config causes an error.

This needs to be researched and an issue filed at Maven, so I don't think it's going to be fixed for 1.3.5.

[Wendy Smoak]

See: http://jira.codehaus.org/browse/MJAVADOC-72 (Aggregating javadocs doesn't work)

[Paul Benedict]

2.0 of plug-in can now aggregate javadocs.

[Wendy Smoak]

If aggregation is now working, the site will need some changes.

The index page here probably needs to be removed:
   http://svn.apache.org/repos/asf/struts/struts1/trunk/src/site/xdoc/apidocs/

Also, any links to Javadoc pages need to be checked. They probably link to docs under the various modules, which I assume will no longer exist.

[Paul Benedict]

URL: http://svn.apache.org/viewvc?view=rev&rev=481594
Log:
STR-2839: Delete apidocs stub to make room for aggregate javadocs

Removed:
    struts/struts1/trunk/src/site/xdoc/apidocs/

[Niall Pemberton]

The aggregated JavaDocs are great - but the JavaDoc links in the User Guide are now broken - so re-openning this.

[Paul Benedict]

URL: http://svn.apache.org/viewvc?view=rev&rev=483347
Log:
STR-2839: Point api links to aggregate location

Modified:
    struts/struts1/trunk/src/site/xdoc/faqs/validator.xml
    struts/struts1/trunk/src/site/xdoc/userGuide/building_controller.xml
    struts/struts1/trunk/src/site/xdoc/userGuide/building_view.xml
    struts/struts1/trunk/src/site/xdoc/userGuide/configuration.xml
    struts/struts1/trunk/src/site/xdoc/userGuide/dev_util.xml
    struts/struts1/trunk/src/site/xdoc/userGuide/introduction.xml