mkdoc Namespace Reference

Classes
class	ExtractionThread
class	NoFilenamesError

Functions
def	d (s)
def	sanitize_name (name)
def	process_comment (comment)
def	extract (filename, node, prefix, output)
def	read_args (args)
def	extract_all (args)
def	write_header (comments, out_file=sys.stdout)
def	mkdoc (args)

Variables
list	RECURSE_LIST
list	PRINT_LIST
list	PREFIX_BLACKLIST
dictionary	CPP_OPERATORS
	job_count = cpu_count()
	job_semaphore = Semaphore(job_count)

Function Documentation

d()

def mkdoc.d

(

s

)

Definition at line 69 of file mkdoc.py.

extract()

def mkdoc.extract	(		filename,
			node,
			prefix,
			output
	)

Definition at line 193 of file mkdoc.py.

extract_all()

def mkdoc.extract_all

(

args

)

Definition at line 283 of file mkdoc.py.

mkdoc()

def mkdoc.mkdoc

(

args

)

Definition at line 343 of file mkdoc.py.

process_comment()

def mkdoc.process_comment

(

comment

)

Definition at line 83 of file mkdoc.py.

read_args()

def mkdoc.read_args

(

args

)

Definition at line 235 of file mkdoc.py.

sanitize_name()

def mkdoc.sanitize_name

(

name

)

Definition at line 73 of file mkdoc.py.

write_header()

def mkdoc.write_header	(		comments,
			out_file = sys.stdout
	)

Definition at line 297 of file mkdoc.py.

Variable Documentation

CPP_OPERATORS

CPP_OPERATORS

Initial value:

=  {
    '<=': 'le', '>=': 'ge', '==': 'eq', '!=': 'ne', '[]': 'array',
    '+=': 'iadd', '-=': 'isub', '*=': 'imul', '/=': 'idiv', '%=':
    'imod', '&=': 'iand', '|=': 'ior', '^=': 'ixor', '<<=': 'ilshift',
    '>>=': 'irshift', '++': 'inc', '--': 'dec', '<<': 'lshift', '>>':
    'rshift', '&&': 'land', '||': 'lor', '!': 'lnot', '~': 'bnot',
    '&': 'band', '|': 'bor', '+': 'add', '-': 'sub', '*': 'mul', '/':
    'div', '%': 'mod', '<': 'lt', '>': 'gt', '=': 'assign', '()': 'call'
}

Definition at line 48 of file mkdoc.py.

job_count

job_count = cpu_count()

Definition at line 61 of file mkdoc.py.

job_semaphore

job_semaphore = Semaphore(job_count)

Definition at line 62 of file mkdoc.py.

PREFIX_BLACKLIST

list PREFIX_BLACKLIST

Initial value:

=  [
    CursorKind.TRANSLATION_UNIT
]

Definition at line 44 of file mkdoc.py.

PRINT_LIST

list PRINT_LIST

Initial value:

=  [
    CursorKind.CLASS_DECL,
    CursorKind.STRUCT_DECL,
    CursorKind.ENUM_DECL,
    CursorKind.ENUM_CONSTANT_DECL,
    CursorKind.CLASS_TEMPLATE,
    CursorKind.FUNCTION_DECL,
    CursorKind.FUNCTION_TEMPLATE,
    CursorKind.CONVERSION_FUNCTION,
    CursorKind.CXX_METHOD,
    CursorKind.CONSTRUCTOR,
    CursorKind.FIELD_DECL
]

Definition at line 30 of file mkdoc.py.

RECURSE_LIST

list RECURSE_LIST

Initial value:

=  [
    CursorKind.TRANSLATION_UNIT,
    CursorKind.NAMESPACE,
    CursorKind.CLASS_DECL,
    CursorKind.STRUCT_DECL,
    CursorKind.ENUM_DECL,
    CursorKind.CLASS_TEMPLATE
]

Definition at line 21 of file mkdoc.py.