Reposition Example Usage sections above @param/@return in JavaDoc

[Copilot]

JavaDoc comments in logging modules had Example Usage sections positioned after parameter documentation, reducing readability. Reorganized 14 files to place Example Usage code examples above @param/@return tags for better documentation flow.

Changes

• Log4j adapter: Log4jLogger.java
• Log4j2 adapter: Log4j2Logger.java, LogEventComparator.java, InMemoryAppender.java, layout utilities, and Log4j2Utils.java
• Commons & Test: LoggingMXBeanAdapter.java and 6 test infrastructure files

Example

// Before
/**
 * Creates a new {@link Log4j2Logger} for the given logger name.
 *
 * @param loggerName the name of the logger
 *
 * <h3>Example Usage</h3>
 * <pre>{@code
 *   Log4j2Logger logger = new Log4j2Logger("io.microsphere");
 * }</pre>
 */

// After
/**
 * Creates a new {@link Log4j2Logger} for the given logger name.
 *
 * <h3>Example Usage</h3>
 * <pre>{@code
 *   Log4j2Logger logger = new Log4j2Logger("io.microsphere");
 * }</pre>
 * @param loggerName the name of the logger
 */

Documentation structure unchanged; formatting preserved.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines	Coverage Δ	Complexity Δ
...java/io/microsphere/logging/log4j/Log4jLogger.java	100.00% <ø> (ø)	17.00 <0.00> (ø)
...va/io/microsphere/logging/log4j2/Log4j2Logger.java	100.00% <ø> (ø)	17.00 <0.00> (ø)
...microsphere/logging/log4j2/LogEventComparator.java	100.00% <ø> (ø)	3.00 <0.00> (ø)
...here/logging/log4j2/appender/InMemoryAppender.java	100.00% <ø> (ø)	13.00 <0.00> (ø)
...sphere/logging/log4j2/layout/DelegatingLayout.java	100.00% <ø> (ø)	11.00 <0.00> (ø)
...logging/log4j2/layout/SmartFileAppenderLayout.java	41.30% <ø> (ø)	11.00 <0.00> (ø)
...o/microsphere/logging/log4j2/util/Log4j2Utils.java	100.00% <ø> (ø)	33.00 <0.00> (ø)
.../microsphere/logging/jmx/LoggingMXBeanAdapter.java	100.00% <ø> (ø)	12.00 <0.00> (ø)
...osphere/logging/test/junit4/LoggingLevelsRule.java	100.00% <ø> (ø)	3.00 <0.00> (ø)
...re/logging/test/junit4/LoggingLevelsStatement.java	100.00% <ø> (ø)	4.00 <0.00> (ø)
... and 4 more

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[augmentcode]

🤖 Augment PR Summary

Summary: Improves JavaDoc readability by moving “Example Usage” sections above the @param/@return tag blocks across the logging modules.

Changes:

• Reordered constructor JavaDocs in Log4j and Log4j2 logger adapters so examples appear before parameter documentation.
• Adjusted method JavaDocs in Log4j2 support code (e.g., comparator, in-memory appender, layouts, and `Log4j2Utils`) to keep examples close to the main narrative.
• Applied the same documentation flow to the commons JMX adapter (`LoggingMXBeanAdapter`).
• Aligned JUnit4/JUnit5 test infrastructure JavaDocs to use the same structure for consistency.

Technical Notes: This PR changes documentation ordering/whitespace only; no runtime logic is modified.

_{🤖 Was this summary useful? React with 👍 or 👎}

[augmentcode]

Review completed. 1 suggestion posted.

Comment augment review to trigger a new review at any time.

[augmentcode]

Note: .github/scripts/generate-wiki-docs.py treats the Javadoc description as everything before the first @ tag; moving the <h3>Example Usage</h3>/<pre> block above @param will now include that HTML in method.description and may duplicate or awkwardly render examples in generated wiki docs.

Severity: low

_{🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.}