Uploaded image for project: 'Apache Avro'
  1. Apache Avro
  2. AVRO-1380

Javadoc warning produced by avro-generated java source

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.7.5
    • Fix Version/s: 1.7.6
    • Component/s: java
    • Labels:
      None

      Description

      The following warnings are produced when generating javadoc documentation from avro-generated java code.

      WARNING] /myworkspace/src/dto/MyClass.java:28: warning - Tag @link:illegal character: "92" in "#newBuilder()"
      [WARNING] myworkspace/target/generated-sources/dto/MyClass.java:28: warning - Tag @link: reference not found: #newBuilder()

      The warnings are caused by the back-slash character (ascii 92) in the expression in curly braces in the comment below. This comment is generated by avro code and is not in the avdl file.

      23 /**
      24 * Default constructor. Note that this does not initialize fields
      25 * to their default values from the schema. If that is desired then
      26 * one should use

      {@link \#newBuilder()}

      .
      27 */
      28 public MyClass() {}

        Attachments

          Activity

            People

            • Assignee:
              cutting Doug Cutting
              Reporter:
              psangree Paul Sangree
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: