Thread: [Japi-cvs] SF.net SVN: japi:[998] progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn
Status: Beta
                
                Brought to you by:
                
                    christianhujer
                    
                
            | 
     
      
      
      From: <chr...@us...> - 2009-02-20 00:07:16
       
   | 
Revision: 998
          http://japi.svn.sourceforge.net/japi/?rev=998&view=rev
Author:   christianhujer
Date:     2009-02-20 00:07:12 +0000 (Fri, 20 Feb 2009)
Log Message:
-----------
Fixed checkstyle issues.
Modified Paths:
--------------
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java	2009-02-20 00:06:55 UTC (rev 997)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java	2009-02-20 00:07:12 UTC (rev 998)
@@ -28,12 +28,21 @@
     /** Serial version. */
     private static final long serialVersionUID = 1L;
 
+    /** Contents of this card. */
     private final String[] fieldContents = new String[6];
 
+    /** Sets a field of this card.
+     * @param fieldIndex Index of the field to set.
+     * @param fieldContent New value for the field.
+     */
     public void setField(final int fieldIndex, final String fieldContent) {
         fieldContents[fieldIndex] = fieldContent;
     }
 
+    /** Returns a field of this card.
+     * @param fieldIndex Index of the field to return.
+     * @return The value of that field.
+     */
     public String getField(final int fieldIndex) {
         return fieldContents[fieldIndex];
     }
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java	2009-02-20 00:06:55 UTC (rev 997)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java	2009-02-20 00:07:12 UTC (rev 998)
@@ -27,6 +27,7 @@
     /** Serial version. */
     private static final long serialVersionUID = 1L;
 
+    /** Names of the fields of cards in this database. */
     private final String[] fieldNames = new String[6];
 
     /** Creates a CardDatabaseConfig.
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java	2009-02-20 00:06:55 UTC (rev 997)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java	2009-02-20 00:07:12 UTC (rev 998)
@@ -29,7 +29,7 @@
 /** The CardDatabaseConfigEditor allows editing a CardDatabaseConfig.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  */
-public class CardDatabaseConfigEditor extends JComponent {
+public final class CardDatabaseConfigEditor extends JComponent {
 
     /** The CardDatabaseConfig to edit. */
     private final CardDatabaseConfig config;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
 | 
| 
     
      
      
      From: <chr...@us...> - 2009-02-24 02:28:44
       
   | 
Revision: 1179
          http://japi.svn.sourceforge.net/japi/?rev=1179&view=rev
Author:   christianhujer
Date:     2009-02-24 02:27:09 +0000 (Tue, 24 Feb 2009)
Log Message:
-----------
Fixed javadoc issues.
Modified Paths:
--------------
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java	2009-02-24 02:26:35 UTC (rev 1178)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java	2009-02-24 02:27:09 UTC (rev 1179)
@@ -28,7 +28,9 @@
     /** Serial version. */
     private static final long serialVersionUID = 1L;
 
-    /** Contents of this card. */
+    /** Contents of this card.
+     * @serial include
+     */
     private final String[] fieldContents = new String[6];
 
     /** Sets a field of this card.
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java	2009-02-24 02:26:35 UTC (rev 1178)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java	2009-02-24 02:27:09 UTC (rev 1179)
@@ -27,7 +27,9 @@
     /** Serial version. */
     private static final long serialVersionUID = 1L;
 
-    /** Names of the fields of cards in this database. */
+    /** Names of the fields of cards in this database.
+     * @serial include
+     */
     private final String[] fieldNames = new String[6];
 
     /** Creates a CardDatabaseConfig.
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java	2009-02-24 02:26:35 UTC (rev 1178)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java	2009-02-24 02:27:09 UTC (rev 1179)
@@ -31,13 +31,19 @@
  */
 public final class CardDatabaseConfigEditor extends JComponent {
 
-    /** The CardDatabaseConfig to edit. */
+    /** The CardDatabaseConfig to edit.
+     * @serial include
+     */
     private final CardDatabaseConfig config;
 
-    /** The labels for the fields. */
+    /** The labels for the fields.
+     * @serial include
+     */
     private final JLabel[] labels = new JLabel[6];
 
-    /** The textfields for the fields. */
+    /** The textfields for the fields.
+     * @serial include
+     */
     private final JTextField[] fields = new JTextField[6];
 
     /** Creates a CardDatabaseConfigEditor.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
 | 
| 
     
      
      
      From: <chr...@us...> - 2009-03-02 01:57:02
       
   | 
Revision: 1267
          http://japi.svn.sourceforge.net/japi/?rev=1267&view=rev
Author:   christianhujer
Date:     2009-03-02 01:39:29 +0000 (Mon, 02 Mar 2009)
Log Message:
-----------
Add @since information for classes and packages.
Modified Paths:
--------------
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabase.java
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java
    progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java	2009-03-02 01:36:45 UTC (rev 1266)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/Card.java	2009-03-02 01:39:29 UTC (rev 1267)
@@ -22,6 +22,7 @@
 /**
  * Class Description.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public class Card implements Serializable {
 
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabase.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabase.java	2009-03-02 01:36:45 UTC (rev 1266)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabase.java	2009-03-02 01:39:29 UTC (rev 1267)
@@ -19,6 +19,7 @@
 
 /** Provides Access to a Card Database.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public interface CardDatabase {
 
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java	2009-03-02 01:36:45 UTC (rev 1266)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfig.java	2009-03-02 01:39:29 UTC (rev 1267)
@@ -21,6 +21,7 @@
 
 /** The Configuration of a CardDatabase.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public class CardDatabaseConfig implements Serializable {
 
Modified: progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java
===================================================================
--- progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java	2009-03-02 01:36:45 UTC (rev 1266)
+++ progs/cardlearn/trunk/src/prj/net/sf/japi/cardlearn/CardDatabaseConfigEditor.java	2009-03-02 01:39:29 UTC (rev 1267)
@@ -28,6 +28,7 @@
 
 /** The CardDatabaseConfigEditor allows editing a CardDatabaseConfig.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public final class CardDatabaseConfigEditor extends JComponent {
 
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
 |