[Japi-cvs] SF.net SVN: japi:[1283] libs/swing-action/trunk/src

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

Revision: 1283
          http://japi.svn.sourceforge.net/japi/?rev=1283&view=rev
Author:   christianhujer
Date:     2009-05-09 22:16:25 +0000 (Sat, 09 May 2009)

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

Modified Paths:
--------------
    libs/swing-action/trunk/src/prj/net/sf/japi/swing/action/ActionBuilder.java
    libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/ActionBuilderFactoryTest.java
    libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/DefaultActionBuilderTest.java
    libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/ReflectionActionTest.java

Modified: libs/swing-action/trunk/src/prj/net/sf/japi/swing/action/ActionBuilder.java
===================================================================
--- libs/swing-action/trunk/src/prj/net/sf/japi/swing/action/ActionBuilder.java	2009-05-09 22:16:07 UTC (rev 1282)
+++ libs/swing-action/trunk/src/prj/net/sf/japi/swing/action/ActionBuilder.java	2009-05-09 22:16:25 UTC (rev 1283)
@@ -47,24 +47,25 @@
  *  <li>Manage an ActionMap to which created Actions are automatically added</li>
  * </ul>
  * You may choose to use one or more ActionBuilders, depending on the size of your application.
- * You may use to spread Action configuration information accross one or more ResourceBundles and one or more Preferences, as you wish.
- * When looking for values, the Preferences are queried first, in addition order, after that the ResourceBundles, again in addition order, until
- * a value was found. The behaviour when no value was found is undefined.
+ * You may spread Action configuration information accross one or more ResourceBundles and one or more Preferences, as you wish.
+ * When looking for values, the Preferences are queried first, then the ResourceBundles, until a value was found.
+ * The Preferences as well as the ResourceBundles are queried in the order in which they've been added.
+ * The behaviour when no value was found is undefined.
  * <h3>Usage</h3>
  * The recommended usage is to
  * <ol>
  *  <li>
  *      create and initialize an ActionBuilder similar as the following example code, put it somewhere at the start of your program:
  * <pre>
- * ActionBuilder myActionBuilder = ActionBuilder.getActionBuilder("MyApplication");
- * myActionBuilder.addBundle("com.mycompany.mypackage.myresource"); // not always required
- * myActionBuilder.addPref(MyClass.class);
+ * ActionBuilder myActionBuilder = ActionBuilderFactory.getActionBuilder("MyApplication");
+ * myActionBuilder.addBundle("com.mycompany.mypackage.myresource"); // Not always required.
+ * myActionBuilder.addPref(MyClass.class); // Not always required.
  * </pre>
  *  </li>
  *  <li>
  *      then use the ActionBuilder from anywhere within the application like this:
  * <pre>
- * ActionBuilder myActionBuilder = ActionBuilder.getActionBuilder("MyApplication");
+ * ActionBuilder myActionBuilder = ActionBuilderFactory.getActionBuilder("MyApplication");
  * Action myAction = myActionBuilder.createAction("load", this);
  * </pre>
  *  </li>
@@ -78,7 +79,7 @@
  *  <li>
  *      The builder name is used to try to load a resource bundle when a bundle is created.
  *      The builder name is used as package name for the bundle, the bundle name itself is "action".
- *      Example: When calling <code>ActionBuilder.getActionBuilder("net.sf.japi.swing");</code> for the first time, it is tried to load a
+ *      Example: When calling <code>ActionBuilderFactory.getActionBuilder("net.sf.japi.swing");</code> for the first time, it is tried to load a
  *      {@link ResourceBundle} named <code>net.sf.japi.swing.actions</code> for that <code>ActionBuilder</code>.
  *      This automatism has been implemented to save you from the need of initializing an ActionBuilder before use.
  *  </li>
@@ -132,6 +133,7 @@
  * @see Action
  * @see Preferences
  * @see ResourceBundle
+ * @see ActionBuilderFactory
  * @todo think about toolbar interaction
  * @todo think about toolbar configuration
  * @todo whether a dialog is a onetime dialog should be a property and user configurable

Modified: libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/ActionBuilderFactoryTest.java
===================================================================
--- libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/ActionBuilderFactoryTest.java	2009-05-09 22:16:07 UTC (rev 1282)
+++ libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/ActionBuilderFactoryTest.java	2009-05-09 22:16:25 UTC (rev 1283)
@@ -26,6 +26,7 @@
 
 /** Test for {@link ActionBuilderFactory}.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public class ActionBuilderFactoryTest {
 

Modified: libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/DefaultActionBuilderTest.java
===================================================================
--- libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/DefaultActionBuilderTest.java	2009-05-09 22:16:07 UTC (rev 1282)
+++ libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/DefaultActionBuilderTest.java	2009-05-09 22:16:25 UTC (rev 1283)
@@ -27,10 +27,9 @@
 import org.junit.Assert;
 import org.junit.Test;
 
-/**
- * Test for {@link DefaultActionBuilder}.
- *
+/** Test for {@link DefaultActionBuilder}.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public class DefaultActionBuilderTest {
 

Modified: libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/ReflectionActionTest.java
===================================================================
--- libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/ReflectionActionTest.java	2009-05-09 22:16:07 UTC (rev 1282)
+++ libs/swing-action/trunk/src/tst/test/net/sf/japi/swing/ReflectionActionTest.java	2009-05-09 22:16:25 UTC (rev 1283)
@@ -29,10 +29,9 @@
 import org.junit.Before;
 import org.junit.Test;
 
-/**
- * Test for {@link ReflectionAction}.
- *
+/** Test for {@link ReflectionAction}.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public class ReflectionActionTest {
 


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