doxypy Namespace Reference

Data Structures
class	Doxypy
class	FSM

Functions
def	optParse
def	main

Variables
string	__applicationName__ = "doxypy"
string	__blurb__
	__doc__ = __blurb__+\
string	__version__ = "0.4.2"
string	__date__ = "14th October 2009"
string	__website__ = "http://code.foosel.org/doxypy"
tuple	__author__
string	__licenseName__ = "GPL v2"
string	__license__

Function Documentation

def doxypy.main

(

void

)

Starts the parser on the file given by the filename as the first 
argument on the commandline.

Here is the call graph for this function:

def doxypy.optParse

(

)

Parses commandline options.

Variable Documentation

string __applicationName__ = "doxypy"

tuple __author__

Initial value:

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

string __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 __date__ = "14th October 2009"

__doc__ = __blurb__+\

string __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 __licenseName__ = "GPL v2"

string __version__ = "0.4.2"

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