HappyDoc Generated Documentation HappyDoc3-r3_1/happydoclib/parseinfo/parsecomments.py

HappyDoc3-r3_1 / happydoclib / parseinfo / parsecomments.py 

Parse comment information from a module.

Functions   
  extractComments 
extractComments (
        text,
        extractRe=re.compile( '^((?P\s*$)|(?P(?P\s*)(?P(class|def))\s+(?P[0-9A-Za-z_]+))|(?P\s*#+(?P.*)))' ).search,
        ignoreRe=re.compile( '\s*[+-=#][ +-=#]*\s*$' ).match,
        )

Given a block of Python source, extract the comments.

The comment text is associated with nearby named objects (functions, methods, classes, etc.). This function returns a dictionary of names and the associated comment text.

Arguments
text
The Python source to be scanned.
Classes   

ParseStack

Helper class for extractComments function in this module.

ParseCommentsTest


This document was automatically generated Tue Dec 5 08:31:01 2006 by HappyDoc version 3.1