doxypy Namespace Reference

Classes
class	FSM
	FSM implements a finite state machine. More...
class	Doxypy
Functions
def	loadFile
	Loads file "filename" and returns the content.
def	optParse
	Parses commandline options.
def	main
	Opens the file given as first commandline argument and processes it, then prints out the processed file.
Variables
string	__applicationName__ = "doxypy"
string	__blurb__
	__doc__ = __blurb__+\
string	__version__ = "0.3rc2"
string	__date__ = "18th December 2007"
string	__website__ = "http://code.foosel.org/doxypy"
tuple	__author__
string	__licenseName__ = "GPL v2"
string	__license__

---

Function Documentation

def doxypy::loadFile

(

filename

)

Loads file "filename" and returns the content.

Parameters:

filename

The name of the file to load

Returns:

the content of the file.

def doxypy::main

(

)

Opens the file given as first commandline argument and processes it, then prints out the processed file.

def doxypy::optParse

(

)

Parses commandline options.

---

Variable Documentation

string doxypy::__applicationName__ = "doxypy"

tuple doxypy::__author__

Initial value:

(
        "Philippe 'demod' Neumann (doxypy at demod dot org)",
        "Gina 'foosel' Haeussge (gina at foosel dot net)" 
)

string doxypy::__blurb__

Initial value:

"""
doxypy is an input filter for Doxygen. It preprocesses python
files so that docstrings of classes and functions are reformatted
into Doxygen-conform documentation blocks.
"""

string doxypy::__date__ = "18th December 2007"

doxypy::__doc__ = __blurb__+\

string doxypy::__license__

Initial value:

"""This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""

string doxypy::__licenseName__ = "GPL v2"

string doxypy::__version__ = "0.3rc2"

string doxypy::__website__ = "http://code.foosel.org/doxypy"