svn commit: r16212 - trunk/src/argouml-core-model/src/org/argouml/model/Facade.java

Author: tfmorris
Date: 2008-12-01 01:13:03-0800
New Revision: 16212

Modified:
   trunk/src/argouml-core-model/src/org/argouml/model/Facade.java

Log:
Javadoc updates.  No functional change.

Modified: trunk/src/argouml-core-model/src/org/argouml/model/Facade.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-core-model/src/org/argouml/model/Facade.java?view=diff&rev=16212&p1=trunk/src/argouml-core-model/src/org/argouml/model/Facade.java&p2=trunk/src/argouml-core-model/src/org/argouml/model/Facade.java&r1=16211&r2=16212
==============================================================================
--- trunk/src/argouml-core-model/src/org/argouml/model/Facade.java	(original)
+++ trunk/src/argouml-core-model/src/org/argouml/model/Facade.java	2008-12-01 01:13:03-0800
@@ -654,7 +654,12 @@
     boolean isAModel(Object handle);
 
     /**
-     * Recognizer for ModelElement.
+     * Recognizer for ModelElement.  <em>NOTE:</em> Consider using {@link
+     * Facade#isAUMLElement(Object)} instead since it is more likely to do what
+     * you want.  This is strictly for subtypes of ModelElement which excludes
+     * many UML types such as Multiplicities, TemplateParameters, etc.  It also
+     * will fail to work for UML 2 types which are subtypes of Element, but
+     * not ModelElement.
      *
      * @param handle candidate
      * @return true if handle is a ModelElement
@@ -1528,10 +1533,11 @@
     Collection getClients(Object handle);
 
     /**
-     * Get the client dependencies of a ModelElement.
+     * Get the client dependencies of a ModelElement (i.e. those Dependencies
+     * in which this ModelElement participates as a client).
      *
      * @param handle the ModelElement.
-     * @return an iterator with all client dependencies.
+     * @return a collection of all client dependencies.
      */
     Collection getClientDependencies(Object handle);