Class: CommentDoc
Base class for all classes that represent a parsed comment of some sort.
Constructor
__init__ (self, parsed_comment)
Methods
get (self, tag_name, default='')
Return the value of a particular tag, or None if that tag doesn't exist. Use 'doc' for the comment body itself.
get_as_list (self, tag_name)
Return the value of a tag, making sure that it's a list. Absent tags are returned as an empty-list; single tags are returned as a one-element list.
The returned list is a copy, and modifications do not affect the original object.
to_dict (self)
Return a dictionary representation of the CommentDoc. The keys of this correspond to the tags in the comment, with the comment body in doc.
to_json (self)
Return a JSON representation of the CommentDoc. Keys are as per to_dict.
Properties
doc
Read only
Return the comment body.
see
Read only
Return a list of all @see tags on the comment.
url
Read only
Return a URL for the comment, within the page.