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

JavadocFormatter mishandling class block comment

    Details

    • Type: Bug
    • Status: Closed
    • Resolution: Fixed
    • Affects Version/s: 6.0.12 EE, 6.1.20 EE GA2, 6.1.30 EE GA3, 6.2.0 CE M2
    • Fix Version/s: 6.1.30 EE GA3, 6.2.0 CE M2
    • Component/s: Documentation
    • Labels:
      None
    • Branch Version/s:
      6.1.x
    • Backported to Branch:
      Committed

      Description

      When a class contains a simple non-javadoc comment block as its class comment ...

      ...
      import javax.portlet.PortletURL;
      /*

      • @author Eudaldo Alonso
        */
        public class WikiPageTrashHandler extends BaseTrashHandler {
        ...

      ... the formatter should either convert the comment to a Javadoc comment or leave the block comment as is.

      Instead, the formatter is removing the comment, all the lines before it, and all of the existing Javadoc found within the class.

      To reproduce:
      1. compile liferay-portal
      2. ant format-javadoc -Dlimit=WikiPageTrashHandler

      ... all lines above the class declaration, including the simple non-javadoc comment block, are removed. All other Javadoc (e.g. existing method javadoc) is removed from within the class.

        Attachments

          Issue Links

            Activity

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Days since last comment:
                  6 years, 27 weeks, 5 days ago

                  Packages

                  Version Package
                  6.1.30 EE GA3
                  6.2.0 CE M2