Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4154412

Want @example tag for separating out examples

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Won't Fix
    • Icon: P5 P5
    • None
    • 1.2.0
    • tools

        It would be useful to add an @example tag which
        would be a standard place for engineers/writers
        to add a code example to doc comments.
        An @example tag could contain a code fragment,
        a compilable example, a link to a shared example,
        or a link to a separate example page.

        Some packages that currently have dedicated writers,
        such as Swing, would make use of this tag right away.

        A possible long-term goal would be for each class
        doc comment to have a compilable example.

            dkramersunw Douglas Kramer (Inactive)
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: