svn commit: r14013 - trunk/src/model-mdr/src/org/argouml/model/mdr/XmiReference.java

Author: tfmorris
Date: 2007-12-27 21:04:33-0800
New Revision: 14013

Modified:
   trunk/src/model-mdr/src/org/argouml/model/mdr/XmiReference.java

Log:
Add Javadoc

Modified: trunk/src/model-mdr/src/org/argouml/model/mdr/XmiReference.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/model-mdr/src/org/argouml/model/mdr/XmiReference.java?view=diff&rev=14013&p1=trunk/src/model-mdr/src/org/argouml/model/mdr/XmiReference.java&p2=trunk/src/model-mdr/src/org/argouml/model/mdr/XmiReference.java&r1=14012&r2=14013
==============================================================================
--- trunk/src/model-mdr/src/org/argouml/model/mdr/XmiReference.java	(original)
+++ trunk/src/model-mdr/src/org/argouml/model/mdr/XmiReference.java	2007-12-27 21:04:33-0800
@@ -24,6 +24,12 @@
 
 package org.argouml.model.mdr;
 
+/**
+ * Reference to an XMI element.  Value object containing a tuple
+ * of the system ID (URI) and xmi.id within the given content.
+ * 
+ * @author Tom Morris
+ */
 class XmiReference {
     private final String systemId;
 
@@ -43,7 +49,8 @@
     }
 
     /**
-     * Get the system ID (typically a file name) for the given XMI reference.
+     * Get the system ID (typically a URI pointing to a file) for the given XMI
+     * reference.
      * 
      * @return the systemID value (string containing filename)
      */