aboutsummaryrefslogtreecommitdiffstats
path: root/qface/helper/doc.py
diff options
context:
space:
mode:
Diffstat (limited to 'qface/helper/doc.py')
-rw-r--r--qface/helper/doc.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/qface/helper/doc.py b/qface/helper/doc.py
index 9695136..2b1df51 100644
--- a/qface/helper/doc.py
+++ b/qface/helper/doc.py
@@ -2,7 +2,7 @@ import re
translate = None
"""
-The translare function used for transalting inline tags. The
+The translate function used for translating inline tags. The
function will be called with tag, value arguments.
Example:
@@ -56,6 +56,8 @@ class DocObject:
def parse_doc(s):
+ """ parse a comment in the format of JavaDoc and returns an object, where each JavaDoc tag
+ is a property of the object. """
if not s:
return
doc = DocObject()