You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pivot.apache.org by "Bill van Melle (Created) (JIRA)" <ji...@apache.org> on 2011/11/17 02:59:51 UTC
[jira] [Created] (PIVOT-819) Improve the documentation for BoxPane
and several other components
Improve the documentation for BoxPane and several other components
------------------------------------------------------------------
Key: PIVOT-819
URL: https://issues.apache.org/jira/browse/PIVOT-819
Project: Pivot
Issue Type: Improvement
Components: wtk
Affects Versions: 2.0
Reporter: Bill van Melle
Priority: Minor
Fix For: 2.0.1
Attachments: javadoc-diffs.txt
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.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Assigned] (PIVOT-819) Improve the documentation for BoxPane
and several other components
Posted by "Sandro Martini (Assigned) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIVOT-819?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Sandro Martini reassigned PIVOT-819:
------------------------------------
Assignee: Sandro Martini
> Improve the documentation for BoxPane and several other components
> ------------------------------------------------------------------
>
> Key: PIVOT-819
> URL: https://issues.apache.org/jira/browse/PIVOT-819
> Project: Pivot
> Issue Type: Improvement
> Components: wtk
> Affects Versions: 2.0
> Reporter: Bill van Melle
> Assignee: Sandro Martini
> Priority: Minor
> Fix For: 2.0.1
>
> Attachments: javadoc-diffs.txt
>
>
> 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.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Resolved] (PIVOT-819) Improve the documentation for BoxPane
and several other components
Posted by "Sandro Martini (Resolved) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIVOT-819?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Sandro Martini resolved PIVOT-819.
----------------------------------
Resolution: Fixed
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.
> Improve the documentation for BoxPane and several other components
> ------------------------------------------------------------------
>
> Key: PIVOT-819
> URL: https://issues.apache.org/jira/browse/PIVOT-819
> Project: Pivot
> Issue Type: Improvement
> Components: wtk
> Affects Versions: 2.0
> Reporter: Bill van Melle
> Assignee: Sandro Martini
> Priority: Minor
> Fix For: 2.0.1
>
> Attachments: javadoc-diffs.txt
>
>
> 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.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (PIVOT-819) Improve the documentation for BoxPane
and several other components
Posted by "Bill van Melle (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIVOT-819?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Bill van Melle updated PIVOT-819:
---------------------------------
Attachment: javadoc-diffs.txt
> Improve the documentation for BoxPane and several other components
> ------------------------------------------------------------------
>
> Key: PIVOT-819
> URL: https://issues.apache.org/jira/browse/PIVOT-819
> Project: Pivot
> Issue Type: Improvement
> Components: wtk
> Affects Versions: 2.0
> Reporter: Bill van Melle
> Priority: Minor
> Fix For: 2.0.1
>
> Attachments: javadoc-diffs.txt
>
>
> 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.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira