You are viewing a plain text version of this content. The canonical link for it is here.

Posted to jira@kafka.apache.org by "Andrew Schofield (Jira)" <ji...@apache.org> on 2026/01/13 11:29:00 UTC

[jira] [Created] (KAFKA-20065) Improve tagging of code examples in javadoc

Andrew Schofield created KAFKA-20065:
----------------------------------------

             Summary: Improve tagging of code examples in javadoc
                 Key: KAFKA-20065
                 URL: https://issues.apache.org/jira/browse/KAFKA-20065
             Project: Kafka
          Issue Type: Improvement
          Components: clients
            Reporter: Andrew Schofield
            Assignee: Andrew Schofield
             Fix For: 4.3.0


The code examples in the javadoc often include HTML escaping for double quotes and angle brackets. This can be avoided by tagging the code examples as code, as opposed to just preformatted. The benefit is that the code examples are much more readable in the source code, which makes them much easier for the code authors to read and get correct.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)