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

Javadoc Formatter replicates any Javadoc containing WRITE_ONLY

    Details

    • Type: Bug
    • Status: Open
    • Resolution: Unresolved
    • Affects Version/s: Master
    • Fix Version/s: None
    • Labels:
      None

      Description

      We're currently having an issue with the Javadoc Formatter replicating a field description when the field is referred to elsewhere. This only seems to be occurring with WRITE_ONLY. Consider the following simple Java class:

      public enum FieldMode {
      
      	/**
      	 * This is a description of a field. See {@link #WRITE_ONLY} for details.
      	 */
      	READ_ONLY,
      
      	/**
      	 * This is a description of a field.
      	 */
      	WRITE_ONLY
      }
      

      After running the Javadoc Formatter, the class is rewritten like this:

      public enum FieldMode {
      
      	/**
      	 * This is a description of a field. See {@link #WRITE_ONLY} for details.
      	 */
      	READ_ONLY,
      
      	/**
      	 * This is a description of a field.
      	 */
      	/**
      	 * This is a description of a field.
      	 */
      	WRITE_ONLY
      }
      

      The WRITE_ONLY string is inadvertently forcing the formatter to replicate its Javadoc field description.

        Attachments

          Activity

            People

            • Assignee:
              hugo.huijser Hugo Huijser
              Reporter:
              cody.hoag Cody Hoag
              Participants of an Issue:
              Recent user:
              Cody Hoag
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Days since last comment:
                33 weeks, 5 days ago

                Packages

                Version Package