Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8250766

javadoc adds redundant spaces when @see program element is wrapped

    XMLWordPrintable

Details

    • b21
    • x86_64
    • windows_10
    • Not verified

    Description

      A DESCRIPTION OF THE PROBLEM :
      When the @see javadoc block tag is used for a method or constructor and the parameter list is wrapped then javadoc inserts spaces in front, respectively behind the last parameter.

      This can for example be seen for https://docs.oracle.com/en/java/javase/14/docs/api/java.base/java/net/URL.html#%3Cinit%3E(java.lang.String,java.lang.String,int,java.lang.String,java.net.URLStreamHandler) which has for the "setURLStreamHandlerFactory( java.net.URLStreamHandlerFactory)" link a space between "(" and "j".

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      1. Create javadoc for the class provided below:
      javadoc -d javadoc ./Javadoc.java
      2. Look at the documentation

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      The "See also" link is shows as "Javadoc(String, int, int)" (no space after respectively in front of the parentheses)
      ACTUAL -
      "Javadoc( String, int, int )"

      ---------- BEGIN SOURCE ----------
      package test;

      /**
       * Description
       *
       * @see test.Javadoc#Javadoc(
       * String,
       * int,
       * int
       * )
       */
      public class Javadoc {
          public Javadoc(String s, int a, int b) { }
      }
      ---------- END SOURCE ----------

      Attachments

        Issue Links

          Activity

            People

              hannesw Hannes Wallnoefer
              webbuggrp Webbug Group
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: