PyXMake Developer Guide 1.0
PyXMake
Loading...
Searching...
No Matches
PyXMake.VTL.stm_make.pyx_doxygen Class Reference
Inheritance diagram for PyXMake.VTL.stm_make.pyx_doxygen:
PyXMake.VTL.stm_make._BaseCommandRunner PyXMake.VTL.stm_make.doxy_boxbeam PyXMake.VTL.stm_make.doxy_mcdcore PyXMake.VTL.stm_make.doxy_mcdmapper PyXMake.VTL.stm_make.doxy_mcdpycodac PyXMake.VTL.stm_make.doxy_mcdsubbuck PyXMake.VTL.stm_make.doxy_pyxmake

Public Member Functions

 initialize_options (self)
 
 finalize_options (self)
 
- Public Member Functions inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 run (self)
 

Public Attributes

int verbose = 0
 
str source_path = ''
 
str output_file_path = ''
 
str stype = "Fortran"
 
 scratch_path = os.getcwd()
 
- Public Attributes inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 verbose
 

Static Public Attributes

str description = "Runs the html documentation build process of source code using Doxygen."
 
list user_options
 

Protected Member Functions

 _run_command (self, command)
 
- Protected Member Functions inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 _create_command (self)
 
 _perform_post_actions (self)
 

Static Protected Attributes

str _BUILD_NAME = ''
 
list _INPUT_FILES = []
 

Additional Inherited Members

- Static Protected Member Functions inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 _create_build_dir ()
 

Detailed Description

Base class for encapsulating command line arguments and build process. 

Definition at line 367 of file stm_make.py.

Member Function Documentation

◆ _run_command()

PyXMake.VTL.stm_make.pyx_doxygen._run_command ( self,
command )
protected
Execute build command

Reimplemented from PyXMake.VTL.stm_make._BaseCommandRunner.

Definition at line 403 of file stm_make.py.

◆ finalize_options()

PyXMake.VTL.stm_make.pyx_doxygen.finalize_options ( self)
Post-process options.

Definition at line 395 of file stm_make.py.

◆ initialize_options()

PyXMake.VTL.stm_make.pyx_doxygen.initialize_options ( self)
Set default values for options.

Definition at line 384 of file stm_make.py.

Member Data Documentation

◆ _BUILD_NAME

PyXMake.VTL.stm_make.pyx_doxygen._BUILD_NAME = ''
staticprotected

Definition at line 371 of file stm_make.py.

◆ _INPUT_FILES

list PyXMake.VTL.stm_make.pyx_doxygen._INPUT_FILES = []
staticprotected

Definition at line 372 of file stm_make.py.

◆ description

str PyXMake.VTL.stm_make.pyx_doxygen.description = "Runs the html documentation build process of source code using Doxygen."
static

Definition at line 374 of file stm_make.py.

◆ output_file_path

str PyXMake.VTL.stm_make.pyx_doxygen.output_file_path = ''

Definition at line 391 of file stm_make.py.

◆ scratch_path

PyXMake.VTL.stm_make.pyx_doxygen.scratch_path = os.getcwd()

Definition at line 393 of file stm_make.py.

◆ source_path

PyXMake.VTL.stm_make.pyx_doxygen.source_path = ''

Definition at line 390 of file stm_make.py.

◆ stype

str PyXMake.VTL.stm_make.pyx_doxygen.stype = "Fortran"

Definition at line 392 of file stm_make.py.

◆ user_options

list PyXMake.VTL.stm_make.pyx_doxygen.user_options
static
Initial value:
= [
# The format is (long option, short option, description).
('source-path=', None, 'path to the folder holding source files'),
('verbose=', None, 'controls the logging level (0 - Nothing, 2- Everything) Default: 0 - Nothing'),
('stype=', None, 'define type of source files (Java, Python or left blank) Defaults to: Fortran'),
('scratch-path=', None, 'path to scratch folder where all temporary data is located during the build event'),
('output-file-path=', None, 'path to the output directory'),
]

Definition at line 375 of file stm_make.py.

◆ verbose

int PyXMake.VTL.stm_make.pyx_doxygen.verbose = 0

Definition at line 389 of file stm_make.py.


The documentation for this class was generated from the following file: