Pivot
  1. Pivot
  2. PIVOT-819

Improve the documentation for BoxPane and several other components

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.0
    • Fix Version/s: 2.0.1
    • Component/s: wtk
    • Labels:
      None

      Description

      I started out just wanting to clarify some of the confusing bits about BoxPane, ImageView, and ScrollPane, but ended up filling in javadoc for many places that had none. In particular, there are some style values (Color, Font, Insets) for which I don't think there's any documentation (other than the parts you can infer from a tutorial example). So I put javadoc on their decoders and used @link elements from many of the places they're used.

      I only did this for the wtk package. There are numerous places in the Terra theme that could also link back to Color and Font docs.

      1. javadoc-diffs.txt
        64 kB
        Bill van Melle

        Activity

        Hide
        Sandro Martini added a comment -

        Patch verified and then applied.
        Many thanks to Bill for the patch.

        Bill, if you have other improvements for JavaDoc (you said something on wtk-terra here), please reopen this issue and post here another patch file.

        Show
        Sandro Martini added a comment - Patch verified and then applied. Many thanks to Bill for the patch. Bill, if you have other improvements for JavaDoc (you said something on wtk-terra here), please reopen this issue and post here another patch file.

          People

          • Assignee:
            Sandro Martini
            Reporter:
            Bill van Melle
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development