Uploaded image for project: 'OFBiz'
  1. OFBiz
  2. OFBIZ-185

Integrated Javadocs

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • Trunk
    • Trunk
    • framework
    • None

    Description

      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?

      Attachments

        1. integrated-javadocs.patch
          9 kB
          Leon Torres

        Activity

          People

            Unassigned Unassigned
            leontorres Leon Torres
            Votes:
            2 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: