changeset 12:8101024c942b

Document class man_off
author Thinker K.F. Li <thinker@codemud.net>
date Wed, 25 May 2011 01:15:07 +0800
parents 409e2cd76f72
children c05fac334ab1
files paraspace/dexfile.py
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/paraspace/dexfile.py	Wed May 25 01:11:43 2011 +0800
+++ b/paraspace/dexfile.py	Wed May 25 01:15:07 2011 +0800
@@ -51,6 +51,17 @@
     pass
 
 
+## \brief Manage offset
+#
+# The instances are initialized with a offset.  Every time an instance
+# is called, it return the offset before advancing offset with specify
+# size.
+#
+# moff = man_off(init_off)
+# assert moff(5) == init_off
+# assert moff() == (init_off + 5)
+# assert moff() == (init_off + 5)
+#
 class man_off(object):
     off = None