ofbiz-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Leon Torres (JIRA)" <j...@apache.org>
Subject [jira] Updated: (OFBIZ-185) Integrated Javadocs
Date Fri, 01 Dec 2006 23:37:22 GMT
     [ http://issues.apache.org/jira/browse/OFBIZ-185?page=all ]

Leon Torres updated OFBIZ-185:
------------------------------

    Attachment: integrated-javadocs.patch

Here's a patch implementing this.  Run ant docs to build the javadoc.

And here are updated links for the kind of javadoc it produces:

http://www.opentaps.org/javadocs/version-0.9.3/framework/api/

http://www.opentaps.org/javadocs/version-0.9.3/applications/api/


> Integrated Javadocs
> -------------------
>
>                 Key: OFBIZ-185
>                 URL: http://issues.apache.org/jira/browse/OFBIZ-185
>             Project: OFBiz (The Open for Business Project)
>          Issue Type: Improvement
>    Affects Versions: SVN trunk
>            Reporter: Leon Torres
>            Priority: Minor
>         Attachments: integrated-javadocs.patch
>
>
> Create integrated javadocs for the applications with ant.  Basically recreate in ofbiz
what I did for opentaps here:
> http://www.opentaps.org/javadocs/version-0.9/framework/api/
> http://www.opentaps.org/javadocs/version-0.9/applications/api/
> The idea is to group related components together into a set of two or more javadoc builds
that reference each other.  (And as bonus, the core Java APIs.)
> One solution would be to normalize each component build.xml so they all have a javadoc
output of ${basedir}/javadocs/componentName/api/.  Then use the <link href=""/> element
to correctly reference the relative paths so the links are generated.  Each component has
its own javadoc build, which can get difficult to manage. 
> The other option is to group the components by related function into two or more javadoc
builds such as done in the above links.  (More than two because ant runs out of memory with
one, even when I gave it 1GB of memory.)  This would reqiure a universal build file, say ${basedir}/javadoc.xml.
 The advantages are ease of navigation and ease of customization.  It is also far easier to
implement than having to go and modify every build.xml.
> If the latter method is desired, I will create the instructions for ofbiz.  What would
be the best organization for the components in this case?

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

        

Mime
View raw message