Skip to content

Documentation examples for MultiFileRegexpHeader does not have any header #18809

@romani

Description

@romani

Detected at https://github.com/checkstyle/checkstyle/pull/18802/changes

In that PR we did big progress, but still missed main reason for users to see in html pages java snippet that has some header and it slightly not matching to what is required.

What we should do:
Update ‎src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/header/multifileregexpheader/Example4.java‎ to have no comments of any kind in place where header is required.

Update verifyWithExternalXmlConfig to allow example file to have ability to have no requirements for // xdoc section -- start if such comments does not exists.

Remove // xdoc section -- start from all examples of multifileregexpheader.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions