[sword-svn] r1835 - trunk/include

[dglassey at crosswire.org]

Author: dglassey
Date: 2005-06-28 15:49:58 -0700 (Tue, 28 Jun 2005)
New Revision: 1835

Modified:
   trunk/include/treekey.h
Log:
a start to docs for treekey



Modified: trunk/include/treekey.h
===================================================================
--- trunk/include/treekey.h	2005-06-25 02:52:20 UTC (rev 1834)
+++ trunk/include/treekey.h	2005-06-28 22:49:58 UTC (rev 1835)
@@ -54,13 +54,30 @@
 
 	virtual const char *getFullName() const = 0;
 
+	/** Go to the root node
+	*/
 	virtual void root() = 0;
+	/** Go to the parent of the current node
+	* @return success or failure
+	*/
 	virtual bool parent() = 0;
 
+	/** Go to the first child of the current node
+	* @return success or failure
+	*/
 	virtual bool firstChild() = 0;
+	/** Go to the next sibling of the current node
+	* @return success or failure
+	*/
 	virtual bool nextSibling() = 0;
+	/** Go to the previous sibling of the current node
+	* @return success or failure
+	*/
 	virtual bool previousSibling() = 0;
 
+	/** Does the current node have children?
+	* @return whether or not it does
+	*/
 	virtual bool hasChildren() = 0;
 
 	virtual void append() = 0;