# HG changeset patch
# User Thinker K.F. Li <thinker@codemud.net>
# Date 1294035483 -28800
# Node ID b90a1e2eb9ecf2aa42626e01bdafe1297977e973
# Parent  2f3d523a38714072fbd4bee9141e115e6479d914
Add document for methods

diff -r 2f3d523a3871 -r b90a1e2eb9ec pyink/MBScene.py
--- a/pyink/MBScene.py	Mon Jan 03 14:06:18 2011 +0800
+++ b/pyink/MBScene.py	Mon Jan 03 14:18:03 2011 +0800
@@ -249,6 +249,10 @@
 	    return
 	pass
     
+    ## \brief Collect ID of nodes in the document.
+    #
+    # It is used to implement a fast mapping from an ID to the respective node.
+    #
     def _collect_node_ids(self):
 	self._id2node = {}
 	root = self._root
@@ -269,9 +273,13 @@
 	    pass
 	pass
     
+    ## \brief Return the node with given ID.
+    #
     def get_node(self, node_id):
 	return self._id2node[node_id]
 
+    ## \brief Return a scene node corresponding to a scene group of given ID.
+    #
     def get_scene(self, group_id):
 	return self._group2scene[group_id]