Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-7602

Improve usage of @see tag in Streams JavaDocs

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • None
    • None
    • streams
    • None

    Description

      As discussed on this PR https://github.com/apache/kafka/pull/5273/files/bd8410ed3d5be9ca89e963687aa05e953d712b62..e4e3eed141447baf1c70ff15e2dc0df4e9a33f12#r223510489 we extensively use `@see` tags in Streams API Java docs.

      This ticket is about revisiting all public JavaDocs (KStream, KTable, KGroupedStream, KGroupedTable, etc) and to define and document (in the wiki) a coherent strategy about the usage of `@see` tag, with the goal to guide users on how to use the API, and not too use `@see` too often to avoid confusion.

      Attachments

        Activity

          People

            Unassigned Unassigned
            mjsax Matthias J. Sax
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: