svn commit: r13832 - trunk/src_new/org/argouml/cognitive/ui

Author: tfmorris
Date: 2007-11-23 17:01:52-0800
New Revision: 13832

Modified:
   trunk/src_new/org/argouml/cognitive/ui/GoListToOffenderToItem.java
   trunk/src_new/org/argouml/cognitive/ui/GoListToPosterToItem.java

Log:
Javadoc updates

Modified: trunk/src_new/org/argouml/cognitive/ui/GoListToOffenderToItem.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src_new/org/argouml/cognitive/ui/GoListToOffenderToItem.java?view=diff&rev=13832&p1=trunk/src_new/org/argouml/cognitive/ui/GoListToOffenderToItem.java&p2=trunk/src_new/org/argouml/cognitive/ui/GoListToOffenderToItem.java&r1=13831&r2=13832
==============================================================================
--- trunk/src_new/org/argouml/cognitive/ui/GoListToOffenderToItem.java	(original)
+++ trunk/src_new/org/argouml/cognitive/ui/GoListToOffenderToItem.java	2007-11-23 17:01:52-0800
@@ -1,5 +1,5 @@
 // $Id$
-// Copyright (c) 1996-2006 The Regents of the University of California. All
+// Copyright (c) 1996-2007 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
@@ -81,9 +81,13 @@
      * @see javax.swing.tree.TreeModel#isLeaf(java.lang.Object)
      */
     public boolean isLeaf(Object node) {
-	if (node instanceof ToDoList) return false;
-	if (getChildCount(node) > 0) return false;
-	return true;
+        if (node instanceof ToDoList) {
+            return false;
+        }
+        if (getChildCount(node) > 0) {
+            return false;
+        }
+        return true;
     }
 
 
@@ -103,10 +107,11 @@
     }
 
     /**
-     * Get a list of children.
+     * Get a list of children. Note that unlike its predecessor getChildren(),
+     * this never returns null. If there are no children, it will return an
+     * empty list.
      * 
-     * @param parent
-     *            the parent object to check
+     * @param parent the parent object to check
      * @return a list of children for the given object
      */
     public List<ToDoItem> getChildrenList(Object parent) {

Modified: trunk/src_new/org/argouml/cognitive/ui/GoListToPosterToItem.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src_new/org/argouml/cognitive/ui/GoListToPosterToItem.java?view=diff&rev=13832&p1=trunk/src_new/org/argouml/cognitive/ui/GoListToPosterToItem.java&p2=trunk/src_new/org/argouml/cognitive/ui/GoListToPosterToItem.java&r1=13831&r2=13832
==============================================================================
--- trunk/src_new/org/argouml/cognitive/ui/GoListToPosterToItem.java	(original)
+++ trunk/src_new/org/argouml/cognitive/ui/GoListToPosterToItem.java	2007-11-23 17:01:52-0800
@@ -1,5 +1,5 @@
 // $Id$
-// Copyright (c) 1996-2006 The Regents of the University of California. All
+// Copyright (c) 1996-2007 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
@@ -97,6 +97,10 @@
     }
     
     /**
+     * Get the children of the given parent.  Unlike getChildren(),
+     * this never returns null, instead returning an empty list if
+     * there are no children.
+     * 
      * @param parent the parent object to check for offspring
      * @return the children
      */