Documentation step 3: Properly document node numbering functions.

[SXSI/XMLTree.git] / xml-tree.hpp

diff --git a/xml-tree.hpp b/xml-tree.hpp
index 8d4af6a..aba3160 100644 (file)
--- a/xml-tree.hpp
+++ b/xml-tree.hpp
@@ -142,8 +142,23 @@ public:
   inline bool is_open(node_t) const;
 
   //Numbering functions
+  /**
+   * [depth(n)] returns the depths of node [n]. The root has depth 1.
+   * Runs in O(1)
+   */
   uint32_t depth(node_t) const;
+
+  /**
+   * [preorder(n)] returns the preorder of node [n]. Equivalent to calling
+   * rank on the underlying BP representation.
+   * Runs in O(1)
+   */
   uint32_t preorder(node_t) const;
+
+  /**
+   * [preorder(n)] returns the postorder of node [n].
+   * Runs in O(1)
+   */
   uint32_t postorder(node_t) const;
 
   //Tag functions