mdoc Namespace Reference

Classes
class	MFile
class	Node
Functions
def	__cmp__
def	__init__
def	__init__
def	__str__
def	addChildNode
def	addMFile
def	breadCrumb
def	depth_first
def	extract
def	getId
def	getRef
def	runcmd
def	toIndexPage
def	toIndexXML
def	towiki
def	xscan
Variables
string	action = "store"
list	basedir = args[0]
	children
string	content = ""
string	default = "html"
string	dest = "format"
	dirname
list	docdir = args[1]
list	excludeRegexList = []
tuple	f = open(os.path.join(docdir, m.wikiname), 'w')
string	format = 'html'
tuple	formatter = Formatter(lines, linkdict, 'wiki')
tuple	func = m.funcname.upper()
	funcname
string	help = "specify the output format (html, wiki, web)"
	helptoc = options.helptoc
	htmlname
dictionary	linkdict = {}
	mdocname
string	metavar = "STRING"
dictionary	mfiles = {}
	next = None
	node
	outname = m.wikiname
string	page = ""
string	pagename = 'index.html'
tuple	parser = OptionParser(usage=usage)
	path
	prev = None
tuple	rx = re.compile(ex)
string	sitexml = ""
tuple	toolbox = xscan(basedir)
string	type = "string"
string	usage
int	verb = 0
	webname
	wikiname

---

Function Documentation

def mdoc.__cmp__	(		self,
			other
	)

Definition at line 120 of file mdoc.py.

def mdoc.__init__	(		self,
			basedir,
			dirname,
			name
	)

MFile('sub/file.m') represents a MATLAB M-File.

Definition at line 89 of file mdoc.py.

def mdoc.__init__	(		self,
			dirname
	)

A Node N represents a node in the toolbox hierechy. A node is a
directory in the toolbox hierarchy and contains both M-files and
other sub-directories.

Definition at line 139 of file mdoc.py.

def mdoc::__str__

(

self

)

Definition at line 123 of file mdoc.py.

def mdoc.addChildNode	(		self,
			node
	)

Definition at line 144 of file mdoc.py.

def mdoc.addMFile	(		self,
			mfile
	)

Definition at line 148 of file mdoc.py.

def mdoc.breadCrumb

(

m

)

Definition at line 313 of file mdoc.py.

def mdoc.depth_first

(

node

)

depth_first(NODE) is a generator that implements a depth first
visit of the node hierarchy rooted at NODE.

Definition at line 215 of file mdoc.py.

def mdoc.extract

(

path

)

(BODY, FUNC, BRIEF) = extract(PATH) extracts the comment BODY, the
function name FUNC and the brief description BRIEF from the MATLAB
M-file located at PATH.

Definition at line 228 of file mdoc.py.

def mdoc.getId	(		self,
			format = 'html'
	)

Definition at line 104 of file mdoc.py.

def mdoc.getRef	(		self,
			format = 'html'
	)

Definition at line 112 of file mdoc.py.

def mdoc.runcmd

(

cmd

)

runcmd(CMD) runs the command CMD. The function waits for the
command to complete and correctly react to Ctrl-C by stopping the
process and raising an exception.

Definition at line 69 of file mdoc.py.

def mdoc.toIndexPage	(		self,
			format = 'html',
			depth = 1
	)

Definition at line 153 of file mdoc.py.

def mdoc.toIndexXML

(

self

)

Definition at line 184 of file mdoc.py.

def mdoc.towiki	(		docdir,
			pagename
	)

Definition at line 485 of file mdoc.py.

def mdoc.xscan	(		baseDir,
			subDir = ''
	)

NODE = xscan(BASEDIR) recusrively scans the directory BASEDIR and
construct the toolbox hierarchy rooted at NODE.

Definition at line 272 of file mdoc.py.

---

Variable Documentation

string mdoc::action = "store"

Definition at line 35 of file mdoc.py.

list mdoc::basedir = args[0]

Definition at line 350 of file mdoc.py.

mdoc::children

Definition at line 139 of file mdoc.py.

string mdoc::content = ""

Definition at line 412 of file mdoc.py.

string mdoc::default = "html"

Definition at line 34 of file mdoc.py.

string mdoc::dest = "format"

Definition at line 33 of file mdoc.py.

mdoc::dirname

Definition at line 139 of file mdoc.py.

list mdoc::docdir = args[1]

Definition at line 351 of file mdoc.py.

list mdoc::excludeRegexList = []

Definition at line 19 of file mdoc.py.

tuple mdoc::f = open(os.path.join(docdir, m.wikiname), 'w')

Definition at line 431 of file mdoc.py.

mdoc::format = 'html'

Definition at line 20 of file mdoc.py.

tuple mdoc::formatter = Formatter(lines, linkdict, 'wiki')

Definition at line 415 of file mdoc.py.

tuple mdoc::func = m.funcname.upper()

Definition at line 381 of file mdoc.py.

mdoc::funcname

Definition at line 89 of file mdoc.py.

string mdoc::help = "specify the output format (html, wiki, web)"

Definition at line 36 of file mdoc.py.

mdoc::helptoc = options.helptoc

Definition at line 339 of file mdoc.py.

mdoc::htmlname

Definition at line 89 of file mdoc.py.

dictionary mdoc::linkdict = {}

Definition at line 371 of file mdoc.py.

mdoc::mdocname

Definition at line 89 of file mdoc.py.

string mdoc::metavar = "STRING"

Definition at line 37 of file mdoc.py.

mdoc::mfiles = {}

Definition at line 372 of file mdoc.py.

mdoc::next = None

Definition at line 374 of file mdoc.py.

mdoc::node

Definition at line 89 of file mdoc.py.

mdoc::outname = m.wikiname

Definition at line 397 of file mdoc.py.

string mdoc::page = ""

Definition at line 441 of file mdoc.py.

string mdoc::pagename = 'index.html'

Definition at line 443 of file mdoc.py.

tuple mdoc::parser = OptionParser(usage=usage)

Definition at line 29 of file mdoc.py.

mdoc::path

Definition at line 89 of file mdoc.py.

mdoc::prev = None

Definition at line 373 of file mdoc.py.

tuple mdoc::rx = re.compile(ex)

Definition at line 343 of file mdoc.py.

string mdoc::sitexml = ""

Definition at line 22 of file mdoc.py.

tuple mdoc::toolbox = xscan(basedir)

Definition at line 365 of file mdoc.py.

string mdoc::type = "string"

Definition at line 43 of file mdoc.py.

string mdoc::usage

Initial value:

"""usage: %prog [options] <basedir> <docdir>

Takes all .m files in basedir and its subdirectories and converts
them to html documentation, placing the results in docdir."""

Definition at line 24 of file mdoc.py.

int mdoc::verb = 0

Definition at line 21 of file mdoc.py.

mdoc::webname

Definition at line 89 of file mdoc.py.

mdoc::wikiname

Definition at line 89 of file mdoc.py.