Skip to content

Metadata generation fails on line wrapped type description #9204

@nrmancuso

Description

@nrmancuso

Discovered at #9076 (comment), when a check's class level javadoc property description is line wrapped in mid-sentence, metadata generation is incomplete.

From #9076:

 * Property {@code requiredJavadocPhrase} - Specify the comment text pattern which qualifies a
 * method as designed for extension. Supports multi-line regex. Type is
 * {@code java.util.regex.Pattern}.
 * Default value is {@code ".*"}.

Yields:

            <property default-value=".*" name="requiredJavadocPhrase" type="">
               <description/>
            </property>

Also,

 * Property {@code requiredJavadocPhrase} - Specify the comment text pattern which qualifies a
 * method as designed for extension. Type is {@code java.util.regex.Pattern}.
 * Default value is {@code ".*"}.
 * 

Yields:

            <property default-value=".*"
                      name="requiredJavadocPhrase"
                      type="java.util.regex.Pattern">
               <description>Specify the comment text pattern which qualifies a</description>
            </property>

The following is outdated and incorrect, and can be fixed at #9209:

During a fix remove from configs:

In config/checkstyle_non_main_files_suppressions.xml:

<!-- until https://github.com/checkstyle/checkstyle/issues/9204 -->
   <suppress id="lineLength" files="config_design\.xml" lines="163"/>

In config/suppressions.xml:

  <!-- until https://github.com/checkstyle/checkstyle/issues/9204 -->
  <suppress id="lineLengthXml" files="config_design\.xml" lines="163"/>

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions