Re: [PR] MINOR: fix javadoc warnings [kafka]

[via GitHub]

nikramakrishnan commented on code in PR #15527:
URL: https://github.com/apache/kafka/pull/15527#discussion_r1523270871


##########
core/src/main/java/kafka/log/remote/RemoteLogManager.java:
##########
@@ -1277,7 +1277,8 @@ public static boolean 
isRemoteSegmentWithinLeaderEpochs(RemoteLogSegmentMetadata
      * does not contain any messages/records associated with them.
      *
      * For ex:
-     *  <epoch - start offset>
+     * <pre>
+     *  &lt;epoch - start offset&gt;

Review Comment:
   Does it make sense to cover this and other 'tables' in `@code` like:
   
   ```java
   * <pre>
   * {@code
   * <epoch - start offset>
   * ...
   * }
   * </pre>
   ```
   
   to allow for readability even when reading the class file directly?



-- 
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