svn commit: r16058 - trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/UMLDiagram.java

Author: tfmorris
Date: 2008-11-16 11:07:34-0800
New Revision: 16058

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

Log:
Javadoc updates.  No functional change.

Modified: trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/UMLDiagram.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/UMLDiagram.java?view=diff&rev=16058&p1=trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/UMLDiagram.java&p2=trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/UMLDiagram.java&r1=16057&r2=16058
==============================================================================
--- trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/UMLDiagram.java	(original)
+++ trunk/src/argouml-app/src/org/argouml/uml/diagram/ui/UMLDiagram.java	2008-11-16 11:07:34-0800
@@ -1,5 +1,5 @@
 // $Id$
-// Copyright (c) 1996-2007 The Regents of the University of California. All
+// Copyright (c) 1996-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
@@ -194,9 +194,19 @@
         }
     }
 
-    /*
+    /**
+     * Method called by PGML parser to initialize a diagram after it's been
+     * constructed.  Order of method invocations currently is: <ul>
+     * <li>0-arg constructor
+     * <li>initialize(Object) // UML element representing owner/home model
+     * <li>setName(String)
+     * <li>setScale(double)
+     * <li>setShowSingleMultiplicity(boolean)
+     * <ul>
+     * @param owner UML model element representing owner/namespace/home model
      * @see org.tigris.gef.base.Diagram#initialize(java.lang.Object)
      */
+    @Override
     public void initialize(Object owner) {
         super.initialize(owner);
         /* The following is the default implementation
@@ -541,7 +551,8 @@
      * @see org.argouml.ui.explorer.Relocatable#relocate(java.lang.Object)
      */
     public abstract boolean relocate(Object base);
-    
+
+    @Override
     public final void setProject(Project p) {
 	super.setProject(p);
 	UMLMutableGraphSupport gm = (UMLMutableGraphSupport) getGraphModel();
@@ -607,7 +618,7 @@
      * main app, and should use their own implementation of ModePlace if it's
      * required.
      * @param gf TODO
-     * @param instructions
+     * @param instructions a help string for the user
      * @return The created ModePlace.
      */
     public ModePlace getModePlace(GraphFactory gf, String instructions) {