Skip to content

Align endpoint Javadoc layout - #270

Merged
weppos merged 1 commit into
mainfrom
javadoc-layout
Sep 18, 2026
Merged

weppos merged 1 commit into
mainfrom
javadoc-layout

Conversation

@weppos

@weppos weppos commented Sep 18, 2026 •

Copy link
Copy Markdown
Member

This change gives the Javadoc of all public endpoint methods one layout. The @param names are aligned, the @param and @return text starts with a capital letter, no blank line comes before @return, and @see is the last tag. The @return text names the response in the same word order as the method name, and listCharges now has its missing @param and @return tags.

🔍 QA

  • The test suite passes.

📋 Deployment Pre/Post tasks

None.

:shipit: Deployment Verification

  • QAd

Use one layout for every public endpoint method: aligned @PARAM names, capitalized @PARAM and @return text, no blank line before @return, and @see last. The @return text names the response in the word order of the method name.
@weppos weppos self-assigned this Sep 18, 2026
@weppos weppos added the task label Sep 18, 2026
@weppos
weppos merged commit af078b9 into main Sep 18, 2026
3 checks passed
@weppos
weppos deleted the javadoc-layout branch September 18, 2026 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant