Uploaded image for project: 'Apache Storm'
  1. Apache Storm
  2. STORM-3931

@see tags that are followed by {@link...}

    XMLWordPrintableJSON

Details

    • Task
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • documentation
    • None

    Description

      @see tags have been deprected in JDK9 in favor of @link tags.

      In Storm, several source files contain improperly formatted '@see' tags. This tag expects class name otherwise generates error for unexpected "{" - character code 123 and "@", character code 64. When generating javadoc.

      [INFO] [WARNING] .../storm/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java:51: warning - Tag @see:illegal character: "123" in "{@link ShellLogHandler#setUpContext}"
[INFO] [WARNING] .../storm/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java:51: warning - Tag @see:illegal character: "64" in "{@link ShellLogHandler#setUpContext}"
[INFO] [WARNING] .../storm/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java:51: warning - Tag @see: reference not found: "{@link ShellLogHandler#setUpContext}"

      For example

      storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java#setUpContext

      /**
 * This default implementation saves the {@link ShellProcess} so it can output the process info string later.
 *
 * @param ownerCls - the class which instantiated this ShellLogHandler.
 * @param process  - the current {@link ShellProcess}.
 * @param context  - the current {@link TopologyContext}.
 * @see {@link ShellLogHandler#setUpContext}
 */

      Should just be rolled into the documentation thusly:

      /**
 * This default implementation saves the {@link ShellProcess} so it can output the process info string later. See {@link ShellLogHandler#setUpContext}.
 *
 * @param ownerCls - the class which instantiated this ShellLogHandler.
 * @param process  - the current {@link ShellProcess}.
 * @param context  - the current {@link TopologyContext}.
 */

      or

      /**
 * This default implementation saves the {@link ShellProcess} so it can output the process info string later.
 *
 * @param ownerCls - the class which instantiated this ShellLogHandler.
 * @param process  - the current {@link ShellProcess}.
 * @param context  - the current {@link TopologyContext}.
 * @see ShellLogHandler#setUpContext
 */

      Attachments

        Activity

          People

            bipinprasad Bipin Prasad
            bipinprasad Bipin Prasad
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: