svn commit: r14146 - trunk/src/app/src/org/argouml/uml: diagram ui/foundation/core

Author: mvw
Date: 2008-02-22 13:51:12-0800
New Revision: 14146

Modified:
   trunk/src/app/src/org/argouml/uml/diagram/ArgoDiagram.java
   trunk/src/app/src/org/argouml/uml/ui/foundation/core/ActionNewClass.java

Log:
Amended comments.

Modified: trunk/src/app/src/org/argouml/uml/diagram/ArgoDiagram.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/uml/diagram/ArgoDiagram.java?view=diff&rev=14146&p1=trunk/src/app/src/org/argouml/uml/diagram/ArgoDiagram.java&p2=trunk/src/app/src/org/argouml/uml/diagram/ArgoDiagram.java&r1=14145&r2=14146
==============================================================================
--- trunk/src/app/src/org/argouml/uml/diagram/ArgoDiagram.java	(original)
+++ trunk/src/app/src/org/argouml/uml/diagram/ArgoDiagram.java	2008-02-22 13:51:12-0800
@@ -1,5 +1,5 @@
 // $Id$
-// Copyright (c) 2007 The Regents of the University of California. All
+// Copyright (c) 2007-2008 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
@@ -131,22 +131,33 @@
     public String repair();
 
     /**
-     * Find the all Figs that visualise the given model element in
+     * Find all the Figs that visualise the given model element in
      * this layer, or null if there is none.
      * 
-     * TODO: once GEF includes this same method in Diagram then the can go
+     * TODO: once GEF includes this same method in Diagram then this can go
      * 
      * @see org.tigris.gef.base.Diagram#presentationsFor(java.lang.Object)
      */
     public List presentationsFor(Object obj);
 
-    // TODO: Move to GEF
+    /**
+     * Remove this diagram from existence.
+     * 
+     * TODO: Move to GEF
+     */
     public void remove();
 
+    /**
+     * Keeps track of the project that contains this diagram. 
+     * The Project determines many settings that reflect 
+     * the way the diagram is painted, such as font size.
+     * 
+     * @param p the project that contains this diagram
+     */
     public void setProject(Project p);
 
     /**
-     * Called when the user releases a dragged a FigNode.
+     * Called when the user releases a dragged FigNode.
      * 
      * @param enclosed the enclosed FigNode that was dragged into the encloser
      * @param oldEncloser the previous encloser
@@ -155,8 +166,6 @@
     public void encloserChanged(FigNode enclosed, FigNode oldEncloser,
             FigNode newEncloser);
 
-    // Do nothing, override in subclass.
-
     /**
      * This method shall return any UML modelelements
      * that should be deleted when the diagram gets deleted,
@@ -170,6 +179,11 @@
     public Object getDependentElement();
 
     /**
+     * TODO: MVW: I am not completely sure of the following:<p>
+     * The "namespace" of the diagram is e.g. used when creating new elements
+     * that are shown on the diagram; they will have their namespace set
+     * according this. It is NOT necessarily equal to the "owner". 
+     * 
      * @return the namespace for the diagram
      */
     public Object getNamespace();
@@ -213,10 +227,13 @@
     public void propertyChange(PropertyChangeEvent evt);
 
     /**
-     * The default implementation for diagrams that
-     * have the namespace as their owner.
+     * The owner of a diagram is the modelelement that is saved
+     * with the project in the pgml file, and binds it to the model. <p>
+     * 
+     * This value is shown in the diagram's properties panel
+     * as the "Home model".
      *
-     * @return the namespace
+     * @return the home model
      */
     public Object getOwner();
     

Modified: trunk/src/app/src/org/argouml/uml/ui/foundation/core/ActionNewClass.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/uml/ui/foundation/core/ActionNewClass.java?view=diff&rev=14146&p1=trunk/src/app/src/org/argouml/uml/ui/foundation/core/ActionNewClass.java&p2=trunk/src/app/src/org/argouml/uml/ui/foundation/core/ActionNewClass.java&r1=14145&r2=14146
==============================================================================
--- trunk/src/app/src/org/argouml/uml/ui/foundation/core/ActionNewClass.java	(original)
+++ trunk/src/app/src/org/argouml/uml/ui/foundation/core/ActionNewClass.java	2008-02-22 13:51:12-0800
@@ -1,5 +1,5 @@
 // $Id$
-// Copyright (c) 2004-2006 The Regents of the University of California. All
+// Copyright (c) 2004-2008 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
@@ -34,7 +34,8 @@
 import org.argouml.uml.ui.AbstractActionNewModelElement;
 
 /**
- * Action to create a new class.
+ * Action to create a new class 
+ * in the same namespace as the currently selected classifier.
  *
  * @author Michiel
  */