Document unsupported/missing ParenPad cases under Use Cases section (original) (raw)

Description:

While working on:

• Issue Fix xdocs Examples AST Consistency Test (Reduce suppressions list) #18435
• PR Issue #18435: Fix xdocs Examples AST Consistency Test - parenpad #19983

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.