[xiph-commits] r8698 - trunk/oggdsf/src/lib/codecs/cmml/libCMMLTags

[illiminable at motherfish-iii.xiph.org]

Author: illiminable
Date: 2005-01-08 21:35:28 -0800 (Sat, 08 Jan 2005)
New Revision: 8698

Modified:
   trunk/oggdsf/src/lib/codecs/cmml/libCMMLTags/C_AnchorTag.h
Log:
* Document anchor tag.

Modified: trunk/oggdsf/src/lib/codecs/cmml/libCMMLTags/C_AnchorTag.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/cmml/libCMMLTags/C_AnchorTag.h	2005-01-09 01:15:29 UTC (rev 8697)
+++ trunk/oggdsf/src/lib/codecs/cmml/libCMMLTags/C_AnchorTag.h	2005-01-09 05:35:28 UTC (rev 8698)
@@ -50,17 +50,25 @@
 	C_AnchorTag(void);
 	virtual ~C_AnchorTag(void);
 
-	//Accessors
+	/// Returns the style sheet attribute
 	wstring cls();
+
+	/// Returns the uri that this anchor tag links to
 	wstring href();
 
-	//Mutators
+	/// Sets the style sheet attribute
 	void setCls(wstring inCls);
+
+	/// Sets the uri this anchor tag links to.
 	void setHref(wstring inHref);
 
-	//Other
+	/// Convert this anchor tag to an xml string.
 	virtual wstring toString();
+
+	/// Performs a deep copy and returns you a pointer you can keep
 	C_AnchorTag* clone();
+
+	/// Performs a deep copy and returns you a pointer to the base class you can keep (Virtual contructor)
 	virtual C_CMMLTag* genericClone();
 
 protected:
@@ -68,7 +76,7 @@
 	wstring mCls;
 	wstring mHref;
 
-	//Protected Helper Methods
+	/// Internal method which performs deep copying
 	virtual void privateClone(C_CMMLTag* outTag);
 
 };