[GitHub] [kafka] yashmayya opened a new pull request, #13120: MINOR: Connect Javadocs improvements

[GitBox]

yashmayya opened a new pull request, #13120:
URL: https://github.com/apache/kafka/pull/13120

   Some common themes:
   
   - Replace blank lines (which are ignored) with `<p>` to separate paragraphs. 
For those wondering about the omitted closing `</p>` tags, this is actually the 
recommended style (see 
[here](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html)).
   - Add Javadocs to some (but not all) classes that were missing them.
   - Fix typos and grammatical issues.
   - Add `{@link}` to code references wherever applicable.
   - Replace manually numbered lists with `<ol>`.
   
   For instance, the `AbstractHerder`'s rendered Javadoc before:
   <img width="676" alt="Screenshot 2022-12-03 at 8 01 08 PM" 
src="https://user-images.githubusercontent.com/23502577/212312167-20c0660e-29ee-4c59-9b3f-c2189b784920.png";>
   
   After:
   <img width="688" alt="Screenshot 2022-12-03 at 7 55 44 PM" 
src="https://user-images.githubusercontent.com/23502577/212312232-efa08086-f29c-4d42-a59d-e2083bc52c06.png";>
   
   
   ### Committer Checklist (excluded from commit message)
   - [ ] Verify design and implementation 
   - [ ] Verify test coverage and CI build status
   - [ ] Verify documentation (including upgrade notes)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org