Function dumpDoc

tools/docco/codegrab.py:188–214

Test support. Just prints docco on the module to standard output.

(modulename, directory=None)

def dumpDoc(modulename, directory=None):
    """Test support.  Just prints docco on the module
    to standard output."""
    docco = getObjectsDefinedIn(modulename, directory)
    print 'codegrab.py - ReportLab Documentation Utility'
    print 'documenting', modulename + '.py'
    print '-------------------------------------------------------'
    print
    if docco.functions == []:
        print 'No functions found'
    else:
        print 'Functions:'
        for f in docco.functions:
            print f.proto
            print '    ' + f.doc

    if docco.classes == []:
        print 'No classes found'
    else:
        print 'Classes:'
        for c in docco.classes:
            print c.name
            print '    ' + c.doc
            for m in c.methods:
                print m.proto  # it is already indented in the file!
                print '        ' + m.doc
            print

def test(m='reportlab.platypus.paragraph'):
    dumpDoc(m)