Skip to content

Document unsupported/missing ParenPad cases under Use Cases section #19994

@smita1078

Description

@smita1078

Description:

While working on:

the following content was noticed in the generated ParenPad documentation page under:

"The following cases are not checked"

for ( ; i < j; i++, j--) // no check after left parenthesis
for (Iterator it = xs.iterator(); it.hasNext(); ) // no check before right parenthesis
try (Closeable resource = acquire(); ) // no check before right parenthesis

Currently these cases appear as plain documentation notes in the HTML page, but they are not represented as dedicated xdoc examples/use cases.

These examples also do not fit well into the new AST-consistent Examples section because:

  • they demonstrate unsupported or intentionally unchecked behavior,
  • they are behavioral edge cases rather than configuration-difference examples.

Proposed improvement:

  • introduce/use a dedicated "Use Cases" (or similar) section for such behavioral examples,
  • keep the primary Examples section reserved for AST-consistent configuration examples.

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions