Makeprojects
Loading...
Searching...
No Matches
makeprojects.doxygen Namespace Reference

Module handles doxygen. More...

Classes

class  BuildDoxygenFile
 Class to build doxygen files. More...

Functions

 match (filename)
 Check if the filename is a type that this module supports.
 create_build_object (file_name, priority=90, configurations=None, verbose=False)
 Return an array of BuildDoxygenFile build objects.
 create_clean_object (file_name, priority=90, configurations=None, verbose=False)
 Return an array of BuildDoxygenFile build objects.

Detailed Description

Module handles doxygen.

Build and clean doxygen data

See also
makeprojects.cleanme
makeprojects.buildme

Function Documentation

◆ create_build_object()

makeprojects.doxygen.create_build_object ( file_name,
priority = 90,
configurations = None,
verbose = False )

Return an array of BuildDoxygenFile build objects.

Parameters
file_namePathname to the Doxyfile to build
priorityPriority to build this object
configurationsConfiguration list to build
verboseTrue if verbose output

◆ create_clean_object()

makeprojects.doxygen.create_clean_object ( file_name,
priority = 90,
configurations = None,
verbose = False )

Return an array of BuildDoxygenFile build objects.

Parameters
file_namePathname to the Doxyfile to build
priorityPriority to build this object
configurationsConfiguration list to build
verboseTrue if verbose output

◆ match()

makeprojects.doxygen.match ( filename)

Check if the filename is a type that this module supports.

Parameters
filenameFilename to match
Returns
False if not a match, True if supported