Fix Javadoc for ShadowPausedLooper
#10387
Conversation
There was a problem hiding this comment.
Code Review
This pull request addresses a Javadoc formatting error in ShadowPausedLooper.java by correcting the placement of an 'and' conjunction and ensuring proper linking of enum constants. The fix improves Javadoc clarity. My review includes one suggestion to further refine the line wrapping of a {@link} tag to enhance robustness with Javadoc processing tools and align with common Javadoc formatting practices.
shadows/framework/src/main/java/org/robolectric/shadows/ShadowPausedLooper.java
Show resolved
Hide resolved
The Javadoc for `ShadowPausedLooper` had a formatting error that caused it to not render correctly.
d503b8e to
5079919
Compare
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request effectively addresses Javadoc formatting issues in ShadowPausedLooper.java.
The corrections to {@link} tag syntax and the reformatting of a descriptive list into an HTML unordered list significantly improve the clarity and correctness of the documentation.
These changes adhere to standard Java Javadoc best practices, which emphasize correct syntax for Javadoc tags (e.g., {@link}) and the use of appropriate HTML (e.g., <ul> for lists) to ensure documentation is both machine-parsable and human-readable. The result is an enhancement to the overall quality of the codebase's documentation.
shadows/framework/src/main/java/org/robolectric/shadows/ShadowPausedLooper.java
Show resolved
Hide resolved
shadows/framework/src/main/java/org/robolectric/shadows/ShadowPausedLooper.java
Show resolved
Hide resolved
|
@MGaetan89 Could you give a screenshot for the new comment? |
Of course! Here's a comparison in the IDE:
And a comparison of the HTML Javadoc:
|
The Javadoc for
ShadowPausedLooperhad a formatting error that caused it to not render correctly.This commit also fixes the item list in
ShadowPausedLooper's Javadoc.