changeset 1432:8e8c9ab3818f

Add documentation
author Thinker K.F. Li <thinker@codemud.net>
date Mon, 11 Apr 2011 00:28:45 +0800
parents 60f2c9a24cdb
children 7bd6c0e88ec8 4be04f29fa70
files pyink/domview.py pyink/domview_ui.py
diffstat 2 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/pyink/domview.py	Mon Apr 11 00:05:25 2011 +0800
+++ b/pyink/domview.py	Mon Apr 11 00:28:45 2011 +0800
@@ -665,6 +665,8 @@
         
         return use_node
 
+    ## \brief Remember current frame and layer on the scenes node.
+    #
     def remember_current_frame(self, layer_idx, frame_idx):
         if not isinstance(layer_idx, int):
             raise TypeError, 'layer index should be a integer'
@@ -678,6 +680,8 @@
         timeline_scenes.setAttribute('cur_frame', str(frame_idx))
         pass
 
+    ## \brief Get current frame and layer from the scenes node.
+    #
     def get_current_frame(self):
         timeline_name = self.get_current_timeline()
         timeline = self._cur_comp.get_timeline(timeline_name)
--- a/pyink/domview_ui.py	Mon Apr 11 00:05:25 2011 +0800
+++ b/pyink/domview_ui.py	Mon Apr 11 00:28:45 2011 +0800
@@ -882,10 +882,14 @@
 	max_frame = self._dom.get_max_frame()
 	return max_frame
 
+    ## \brief Remember current frame and layer on the scenes node.
+    #
     def remember_current_frame(self, layer_idx, frame_idx):
         self._dom.remember_current_frame(layer_idx, frame_idx)
         pass
 
+    ## \brief Get current frame and layer from the scenes node.
+    #
     def get_current_frame(self):
         return self._dom.get_current_frame()