[cig-commits] r11281 - short/3D/PyLith/trunk/libsrc/faults

[brad at geodynamics.org]

Author: brad
Date: 2008-02-27 17:46:07 -0800 (Wed, 27 Feb 2008)
New Revision: 11281

Modified:
   short/3D/PyLith/trunk/libsrc/faults/Fault.hh
Log:
Added to documentation comments.

Modified: short/3D/PyLith/trunk/libsrc/faults/Fault.hh
===================================================================
--- short/3D/PyLith/trunk/libsrc/faults/Fault.hh	2008-02-28 01:03:50 UTC (rev 11280)
+++ short/3D/PyLith/trunk/libsrc/faults/Fault.hh	2008-02-28 01:46:07 UTC (rev 11281)
@@ -15,6 +15,10 @@
  * @brief C++ abstract base class for Fault object.
  *
  * Interface definition for fault.
+ *
+ * The fault id is associated with the material-id for the fault and
+ * the label is associated with the group of vertices that define the
+ * fault surface.
  */
 
 #if !defined(pylith_faults_fault_hh)
@@ -64,25 +68,25 @@
   virtual
   ~Fault(void);
 
-  /** Set identifier of fault.
+  /** Set material identifier of fault.
    *
    * @param value Fault identifier
    */
   void id(const int value);
 
-  /** Get identifier of fault.
+  /** Get material identifier of fault.
    *
    * @returns Fault identifier
    */
   int id(void) const;
 
-  /** Set label of fault.
+  /** Set label of group of vertices associated with fault.
    *
    * @param value Label of fault
    */
   void label(const char* value);
 
-  /** Get label of fault.
+  /** Get label of group of vertices associated with fault.
    *
    * @returns Label of fault
    */