svn commit: r16517 - trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/FigEditableCompartment.java

Author: mvw
Date: 2009-01-05 03:09:08-0800
New Revision: 16517

Modified:
   trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/FigEditableCompartment.java

Log:
Comments only.

Modified: trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/FigEditableCompartment.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/FigEditableCompartment.java?view=diff&pathrev=16517&r1=16516&r2=16517
==============================================================================
--- trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/FigEditableCompartment.java	(original)
+++ trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/FigEditableCompartment.java	2009-01-05 03:09:08-0800
@@ -1,5 +1,5 @@
 // $Id$
-// Copyright (c) 1996-2008 The Regents of the University of California. All
+// Copyright (c) 1996-2009 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
@@ -47,7 +47,10 @@
  * make the whole compartment invisible, and
  * a NotationProvider is used to handle (generate and parse) 
  * the texts shown in the compartment, i.e. 
- * the compartment texts are editable by the user.
+ * the compartment texts are editable by the user. <p>
+ * 
+ * This FigGroup shall only contain its bigPort, 
+ * and Figs of type FigSeparator, and CompartmentFigText.
  */
 public abstract class FigEditableCompartment extends FigCompartment {
 
@@ -110,7 +113,7 @@
      * children.
      * This is to save on resources and increase efficiency as multiple
      * figs need not exist and be resized, moved etc if they are not visible.
-     * If a compartment is later made visible the its child figs are rebuilt
+     * If a compartment is later made visible then its child figs are rebuilt
      * from the model.
      * {@inheritDoc}
      */
@@ -156,7 +159,7 @@
     protected abstract Collection getUmlCollection();
 
     /**
-     * @return the type of the notationprovider 
+     * @return the type of the notationProvider 
      *              used to handle the text in the compartment 
      */
     protected abstract int getNotationType();
@@ -394,6 +397,7 @@
 
     /**
      * Fig representing separator for compartment.
+     * This is a horizontal line.
      */
     protected static class FigSeperator extends FigLine {
         /**

------------------------------------------------------
http://argouml.tigris.org/ds/viewMessage.do?dsForumId=5905&dsMessageId=1004815

To unsubscribe from this discussion, e-mail: [[email protected]].