Code_Saturne
CFD tool
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Functions | Variables
doxypy Namespace Reference

Data Structures

class  FSM
 
class  Doxypy
 

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:
1 = (
2  "Philippe 'demod' Neumann (doxypy at demod dot org)",
3  "Gina 'foosel' Haeussge (gina at foosel dot net)"
4 )
string __blurb__
Initial value:
1 = """
2 doxypy is an input filter for Doxygen. It preprocesses python
3 files so that docstrings of classes and functions are reformatted
4 into Doxygen-conform documentation blocks.
5 """
string __date__ = "14th October 2009"
__doc__ = __blurb__+\
string __license__
Initial value:
1 = """This program is free software: you can redistribute it and/or modify
2 it under the terms of the GNU General Public License as published by
3 the Free Software Foundation, either version 2 of the License, or
4 (at your option) any later version.
5 
6 This program is distributed in the hope that it will be useful,
7 but WITHOUT ANY WARRANTY; without even the implied warranty of
8 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 GNU General Public License for more details.
10 
11 You should have received a copy of the GNU General Public License
12 along with this program. If not, see <http://www.gnu.org/licenses/>.
13 """
string __licenseName__ = "GPL v2"
string __version__ = "0.4.2"
string __website__ = "http://code.foosel.org/doxypy"