[GitHub] [kafka] jlprat opened a new pull request #11049: MINOR: Fix small warning on javadoc and scaladoc

[GitBox <gi...@apache.org>]

jlprat opened a new pull request #11049:
URL: https://github.com/apache/kafka/pull/11049


   Escape the `>` character in javadoc
   Escape the `$` character when part of `${}` in scaladoc as this is the
   way to reference a variable
   
   ### 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-unsubscribe@kafka.apache.org

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

[GitHub] [kafka] jlprat commented on pull request #11049: MINOR: Fix small warning on javadoc and scaladoc

[GitBox <gi...@apache.org>]

jlprat commented on pull request #11049:
URL: https://github.com/apache/kafka/pull/11049#issuecomment-879785324


   While testing if all tasks were working for https://github.com/apache/kafka/pull/11025, I realized some warnings were printed for the JavaDoc and ScalaDoc.
   There are still some more present in the ScalaDoc:
   * Ambiguous references (but this has no real solution as the ScalaDoc semantically refers to both
   * Links to JavaDoc do not really work. Any time a Java class is referenced within a ScalaDoc, the target link can't be found. This results in the resulting documentation not linking to anything.


-- 
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-unsubscribe@kafka.apache.org

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