[Japi-cvs] SF.net SVN: japi:[1406] libs/swing-about/trunk/src/prj/net/sf/japi/swing/ about/AboutDialog.java

[<chr...@us...>]

Revision: 1406
          http://japi.svn.sourceforge.net/japi/?rev=1406&view=rev
Author:   christianhujer
Date:     2010-05-16 11:43:49 +0000 (Sun, 16 May 2010)

Log Message:
-----------
Improve documentation.

Modified Paths:
--------------
    libs/swing-about/trunk/src/prj/net/sf/japi/swing/about/AboutDialog.java

Modified: libs/swing-about/trunk/src/prj/net/sf/japi/swing/about/AboutDialog.java
===================================================================
--- libs/swing-about/trunk/src/prj/net/sf/japi/swing/about/AboutDialog.java	2010-04-11 11:06:48 UTC (rev 1405)
+++ libs/swing-about/trunk/src/prj/net/sf/japi/swing/about/AboutDialog.java	2010-05-16 11:43:49 UTC (rev 1406)
@@ -50,6 +50,7 @@
 
 /**
  * Class for constructing and showing About dialogs.
+ *
  * It features:
  * <ul>
  *  <li>logo</li>
@@ -58,6 +59,7 @@
  *  <li>All runtime properties</li>
  *  <li>All licenses the software uses</li>
  * </ul>
+ *
  * It requires the following properties to be available in the named ActionBuilder:
  * <ul>
  *  <li><code>about.logo</code> specifies the logo to display (optional)</li>
@@ -66,12 +68,13 @@
  *      <code>about</code> specifies the format string for the about text in the about tab.
  *      It takes the following parameters:
  *      <ol>
- *          <li>The runtime's Java Version</li>
- *          <li>The build number</li>
- *          <li>The build developer</li>
- *          <li>The build timestamp</li>
+ *          <li><code>{0}</code>: The runtime's Java Version</li>
+ *          <li><code>{1}</code>: The build number (see build resource bundle below)</li>
+ *          <li><code>{2}</code>: The build developer (see build resource bundle below)</li>
+ *          <li><code>{3}</code>: The build timestamp (see build resource bundle below)</li>
  *      </ol>
  *      (See information on the build for how to specify the build information)
+ *      Hint: Use Swing HTML 3.2 if you want formatted text (tables etc.).
  *  </li>
  *  <li>
  *      Licenses:
@@ -84,12 +87,20 @@
  *  <li><code>aboutBuildProperties.title</code> specifies the title for the build properties tab (optional - only required if the build properties tab is used)</li>
  *  <li><code>aboutRuntimeProperties.title</code> specifies the title for the runtime properties tab (required)</li>
  * </ul>
+ *
+ * <h2>build resource bundle</h2>
  * The information on the build is specified by:
  * <ul>
  *  <li>
- *      A ResourceBundle <code>build</code> (optional, e.g. <code>build.properties</code> toplevel on classpath)
+ *      A ResourceBundle <code>build</code> (optional, e.g. <code>build.properties</code> toplevel on classpath).
+ *      All properties in that bundle are going to be displayed on the build tab.
+ *      The following properties have special meaning and are message format parameters to about (see above):
  *      <ul>
- *          <li><code>build.developer</code> The developer that made the build (optional)</li>
+ *          <li>
+ *              <code>build.developer</code> The developer that made the build (optional).
+ *              Note: This is meant to be the developer that performed the build, not the developers that developed the software.
+ *              Use the <code>about</code> property described above to specify copyright / authors / contributors / developers.
+ *          </li>
  *          <li><code>build.number</code> The build number, e.g. incremented by Ant or the Subversion revision (optional)</li>
  *          <li><code>build.tstamp</code> The timestamp when the build was made (optional)</li>
  *      </ul>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.