Base class for all Doxygen build events. More...

Inheritance diagram for PyXMake.Build.Make.Doxygen:

Public Member Functions
def	__init__ (self, args, kwargs)

def	Settings (self, brief, header, outdir='', kwargs)

Public Member Functions inherited from PyXMake.Build.Make.Make
def	__init__ (self, BuildID, Srcs, scratch=os.getcwd(), msvsc='vs2015', stype='Fortran', verbose=0, args, kwargs)

def	__getstate__ (self)

def	__setstate__ (self, _dict)

def	AddIncludePath (self, includes)

def	AddDependencyPath (self, dependencies)

def	UseLibraries (self, libs)

def	SourcePath (self, path)

def	OutputPath (self, path, files="")

def	Environment (self, path, script="ifortvars.bat")

def	Preprocessing

def	Build (self, cmdstring)

def	Postprocessing (self, cmdstring='')

def	create (self)

Public Attributes
	MakeObjectKind
	String identifier of current instance. More...

	path2exe
	Path to Doxygen executable. More...

	exe
	Executable of Doxygen. More...

	stype
	Type of source file. More...

	buildname
	Temporary build name of current job. More...

	temps
	Tuple of temporary files scheduled for removal. More...

	postcmd

	incdirs
	Blank version of list containing library directories without initially specifying MKL. More...

	libdirs

	outdir
	Output directory of current job. More...

Public Attributes inherited from PyXMake.Build.Make.Make
	buildid
	Base string of build object. More...

	srcs
	Source file or folders.

	stype
	Source file type.

	verbose
	Level of verbosity of the current build object. More...

	scrtdir
	Current scratch directory.

	srcdir
	Default search directory for source files. More...

	outdir
	Default search directory for output. More...

	intelpath
	Path to Intel Fortran Compiler (read from Paths.log). More...

	temps
	Tuple of data to be removed after job completion. More...

	incdirs
	List of include directories. More...

	libdirs
	List of library directories. More...

	libs
	List of actual libraries (by name) used during linking. More...

	copyfiles
	List of files to be copied to the output directory after finish. More...

	setarch
	Define the architecture for the build directly by using the keyword argument "arch". More...

	architecture
	Processor architecture.

	iniCompiler
	Executable batch script (including absolute system path) to set up the Intel Fortran Compiler. More...

	msvsc
	Default version of Microsoft visual studio used by the Intel Fortran Compiler. More...

	postcmd
	Post build command. More...

	buildname

	precmd
	Command executed during pre-build event. More...

	compargs
	Command line arguments passed in by the user. More...

	makecmd
	Command executed during build event. More...

Detailed Description

Base class for all Doxygen build events.

Inherited class to automatically build a documentation using Doxygen.

Inherited from Make.

Definition at line 1339 of file Make.py.

Constructor & Destructor Documentation

◆ init()

def PyXMake.Build.Make.Doxygen.__init__	(	self,
		args,
		kwargs
	)

Initialization of doxygen class object.

Definition at line 1343 of file Make.py.

Member Function Documentation

◆ Settings()

def PyXMake.Build.Make.Doxygen.Settings	(	self,
		brief,
		header,
		outdir = `''`,
		kwargs
	)

Define environment variables for the default configuration file.

Definition at line 1443 of file Make.py.

Member Data Documentation

◆ buildname

PyXMake.Build.Make.Doxygen.buildname

Temporary build name of current job.

Definition at line 1368 of file Make.py.

◆ exe

PyXMake.Build.Make.Doxygen.exe

Executable of Doxygen.

Definition at line 1360 of file Make.py.

◆ incdirs

PyXMake.Build.Make.Doxygen.incdirs

Blank version of list containing library directories without initially specifying MKL.

Definition at line 1439 of file Make.py.

◆ MakeObjectKind

PyXMake.Build.Make.Doxygen.MakeObjectKind

String identifier of current instance.

Definition at line 1349 of file Make.py.

◆ outdir

PyXMake.Build.Make.Doxygen.outdir

Output directory of current job.

Defaults to current workspace if not given.

Definition at line 1450 of file Make.py.

◆ path2exe

PyXMake.Build.Make.Doxygen.path2exe

Path to Doxygen executable.

Definition at line 1358 of file Make.py.

◆ stype

PyXMake.Build.Make.Doxygen.stype

Type of source file.

Can be one of Fortran, CCpp or Other. Defaults to Fortran if not specified. Starts documentation procedure for Java/Python if type is neither Fortran nor CCpp.

Definition at line 1365 of file Make.py.

◆ temps

PyXMake.Build.Make.Doxygen.temps

Tuple of temporary files scheduled for removal.

Definition at line 1370 of file Make.py.

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

D:/03_Workspaces/01_Eclipse/pyx_core/PyXMake/Build/Make.py

Public Member Functions

Public Attributes