Class to build doxygen files. More...

Inheritance diagram for makeprojects.doxygen.BuildDoxygenFile:

Collaboration diagram for makeprojects.doxygen.BuildDoxygenFile:

Public Member Functions
	__init__ (self, file_name, priority=90, verbose=False)
	Class to handle Doxyfile files.
	build (self)
	Build documentation using Doxygen.
	clean (self)
	Delete temporary files.
Public Member Functions inherited from makeprojects.build_objects.BuildObject
	__init__ (self, file_name, priority=None, configuration=None)
	Initializers for an BuildObject.
	run_command (self, cmd, verbose)
	Issue a command and return the generated BuildError.
	__repr__ (self)
	Convert the object into a string.
	__str__ (self)
	Convert the object into a string.

Public Attributes
	verbose = verbose
	Save the verbose flag.
Public Attributes inherited from makeprojects.build_objects.BuildObject
	file_name = os.path.abspath(file_name)
	Name of file to build.
	priority = int(priority)
	Numeric priorty in ascending order.
	configuration = configuration
	Configuration if applicable.

Detailed Description

Class to build doxygen files.

Constructor & Destructor Documentation

◆ init()

makeprojects.doxygen.BuildDoxygenFile.__init__	(	self,
		file_name,
		priority = 90,
		verbose = False )

Class to handle Doxyfile files.

Parameters

file_name	Pathname to the Doxyfile to build
priority	Priority to build this object
verbose	True if verbose output

Member Function Documentation

◆ build()

makeprojects.doxygen.BuildDoxygenFile.build ( self )

Build documentation using Doxygen.

  Execute the program ``doxygen`` to create documentation for the
  project building built.

  If the input file is found to have CR/LF line endings on a macOS
  or Linux platform, the file will have the CRs stripped before
  being passed to Doxygen to get around a bug in Doxygen where
  the macOS/Linux versions require LF only line endings.

  All Doxygen errors will be captured and stored in a file called
  temp/doxygenerrors.txt. If there were no errors, this file
  will be deleted if it exists.

Returns: BuildError object

Reimplemented from makeprojects.build_objects.BuildObject.

◆ clean()

makeprojects.doxygen.BuildDoxygenFile.clean ( self )

Delete temporary files.

  This function is called by ``cleanme`` to remove temporary files.

  On exit, return 0 for no error, or a non zero error code if there was an
  error to report. None if not implemented or not applicable.

Returns: None if not implemented, otherwise an integer error code.