Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-4173

Ant tasks to help with Javadoc documentation

    Details

    • Type: Bug
    • Status: Closed
    • Resolution: Fixed
    • Affects Version/s: 5.1.2, 5.2.3
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Branch Version/s:
      5.2.x, 5.1.x
    • Backported to Branch:
      Committed

      Description

      Introduce three new commands:

      "ant javadoc-delete" This command removes all Javadocs from java files

      "ant javadoc-get" This command fetches javadocs that are saved in Xyz.javadoc file extension and merges them into Xyz.java

      "ant javadoc-save" This command saves javadcos that are in Xyz.java into Xyz.javadoc

      These three new commands assume that every .java file will have a .javadoc equivalent XML file that stores all Javadoc documentation. These commands were created so that developers who do not like the clutter of Javadoc code in their source files can have the javadocs abstracted out into a separate file.

      Those who like javadocs get the benefit of adding javadocs for those who like them.

      Do not use these commands until the ticket is closed. They are being checked in and tested in phases.

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Days since last comment:
                10 years, 20 weeks, 2 days ago

                Packages

                Version Package