Source Code for Module epydoc.checker

  1  # 
  2  # objdoc: epydoc documentation completeness checker 
  3  # Edward Loper 
  4  # 
  5  # Created [01/30/01 05:18 PM] 
  6  # $Id: checker.py 1366 2006-09-07 15:54:59Z edloper $ 
  7  # 
  8   
  9  """ 
 10  Documentation completeness checker.  This module defines a single 
 11  class, C{DocChecker}, which can be used to check the that specified 
 12  classes of objects are documented. 
 13  """ 
 14  __docformat__ = 'epytext en' 
 15   
 16  ################################################## 
 17  ## Imports 
 18  ################################################## 
 19   
 20  import re, sys, os.path, string 
 21  from xml.dom.minidom import Text as _Text 
 22  from epydoc.apidoc import * 
 23   
 24  # The following methods may be undocumented: 
 25  _NO_DOCS = ['__hash__', '__repr__', '__str__', '__cmp__'] 
 26   
 27  # The following methods never need descriptions, authors, or 
 28  # versions: 
 29  _NO_BASIC = ['__hash__', '__repr__', '__str__', '__cmp__'] 
 30   
 31  # The following methods never need return value descriptions. 
 32  _NO_RETURN = ['__init__', '__hash__', '__repr__', '__str__', '__cmp__'] 
 33   
 34  # The following methods don't need parameters documented: 
 35  _NO_PARAM = ['__cmp__'] 
 36