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

JavadocFormatter should preserve HTML formatting in tag comments

    Details

    • Type: Bug
    • Status: Closed
    • Resolution: Won't Fix
    • Affects Version/s: 6.1.1 CE GA2, 6.1.20 EE GA2, 6.1.30 EE GA3, 6.2.0 CE M3
    • Fix Version/s: 6.1.30 EE GA3, 6.2.0 CE M3
    • Component/s: Documentation
    • Labels:
      None

      Description

      The JavadocFormatter class preserves formatting of HTML tags (e.g. <p>...</p>) in class and method description comments but does not preserve their formatting in comments for Javadoc tags such as @deprecated.

      For example, in a comment such as the following ...

      /**

      • @deprecated As of 6.2, with no direct replacement.
        *
      • <p>
      • This method was
      • originally defined to determine if a portlet should be
      • displayed in the Control Panel. In this version, this method
      • should alway return <code>false</code> and remains only to
      • preserve binary compatibility. This method will be
      • permanently removed in a future version.
      • </p>
        *
      • <p>
      • In lieu of
      • this method, the Control Panel now uses {@link * #hasAccessPermission}

        to determine if a portlet should be

      • displayed in the Control Panel.
      • </p>
        **/

      ... the formatter changes it to the following, removing the line separations between HTML tags ...

      /**

      • @deprecated As of 6.2, with no direct replacement. <p>This method was
      • originally defined to determine if a portlet should be
      • displayed in the Control Panel. In this version, this method
      • should alway return <code>false</code> and remains only to
      • preserve binary compatibility. This method will be
      • permanently removed in a future version.</p><p>In lieu of
      • this method, the Control Panel now uses {@link * #hasAccessPermission}

        to determine if a portlet should be

      • displayed in the Control Panel.</p>
        **/

        Attachments

          Activity

            People

            Assignee:
            support-lep@liferay.com SE Support
            Reporter:
            james.hinkey James Hinkey
            Participants of an Issue:
            Recent user:
            Esther Sanz
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Days since last comment:
              8 years, 1 week, 1 day ago

                Packages

                Version Package
                6.1.30 EE GA3
                6.2.0 CE M3