Skip to content

Class mkdoxy::doxyrun::DoxygenRun

ClassList > mkdoxy > doxyrun > DoxygenRun

Class for running Doxygen. More...

Public Functions

Type Name
def __init__ (self self, str doxygenBinPath, str doxygenSource, str tempDoxyFolder, doxyCfgNew doxyCfgNew, Optional doxyConfigFile=None)
Constructor.
def checkAndRun (self self)
Check if the source files have changed since the last run and run Doxygen if they have.
str dox_dict2str (self self, dict dox_dict)
Convert a dictionary to a string that can be written to a doxygen config file.
PurePath getOutputFolder (self self)
Get the path to the XML output folder.
bool hasChanged (self self)
Check if the source files have changed since the last run.
bool is_doxygen_valid_path (self self, str doxygen_bin_path)
Check if the Doxygen binary path is valid.
def run (self self)
Run Doxygen with the current configuration using the Popen class.
dict setDoxyCfg (self self, dict doxyCfgNew)
Set the Doxygen configuration.
dict str2dox_dict (self self, str dox_str)
Convert a string from a doxygen config file to a dictionary.

Detailed Description

This class is used to run Doxygen and parse the XML output.

Public Functions Documentation

function __init__

Constructor. 

def mkdoxy::doxyrun::DoxygenRun::__init__ (
    self self,
    str doxygenBinPath,
    str doxygenSource,
    str tempDoxyFolder,
    doxyCfgNew doxyCfgNew,
    Optional doxyConfigFile=None
)

Default Doxygen config options:

  • INPUT: <doxygenSource>
  • OUTPUT_DIRECTORY: <tempDoxyFolder>
  • DOXYFILE_ENCODING: UTF-8
  • GENERATE_XML: YES
  • RECURSIVE: YES
  • EXAMPLE_PATH: examples
  • SHOW_NAMESPACES: YES
  • GENERATE_HTML: NO
  • GENERATE_LATEX: NO

Parameters:

  • doxygenBinPath (str) Path to the Doxygen binary.
  • doxygenSource (str) Source files for Doxygen.
  • tempDoxyFolder (str) Temporary folder for Doxygen.
  • doxyConfigFile (str) Path to a Doxygen config file.
  • doxyCfgNew (dict) New Doxygen config options that will be added to the default config (new options will overwrite default options)

function checkAndRun

Check if the source files have changed since the last run and run Doxygen if they have. 

def mkdoxy::doxyrun::DoxygenRun::checkAndRun (
    self self
)

Returns:

(bool) True if Doxygen was run.

function dox_dict2str

Convert a dictionary to a string that can be written to a doxygen config file. 

str mkdoxy::doxyrun::DoxygenRun::dox_dict2str (
    self self,
    dict dox_dict
)

Parameters:

  • dox_dict (dict) Dictionary to convert.
Returns:

(str) String that can be written to a doxygen config file.

function getOutputFolder

Get the path to the XML output folder. 

PurePath mkdoxy::doxyrun::DoxygenRun::getOutputFolder (
    self self
)

Returns:

(PurePath) Path to the XML output folder.

function hasChanged

Check if the source files have changed since the last run. 

bool mkdoxy::doxyrun::DoxygenRun::hasChanged (
    self self
)

Returns:

(bool) True if the source files have changed since the last run.

function is_doxygen_valid_path

Check if the Doxygen binary path is valid. 

bool mkdoxy::doxyrun::DoxygenRun::is_doxygen_valid_path (
    self self,
    str doxygen_bin_path
)

Accepts a full path or just 'doxygen' if it exists in the system's PATH.

Parameters:

  • doxygen_bin_path (str) The path to the Doxygen binary or just 'doxygen'.
Returns:

(bool) True if the Doxygen binary path is valid, False otherwise.

function run

def mkdoxy::doxyrun::DoxygenRun::run (
    self self
)

function setDoxyCfg

Set the Doxygen configuration. 

dict mkdoxy::doxyrun::DoxygenRun::setDoxyCfg (
    self self,
    dict doxyCfgNew
)

If a custom Doxygen config file is provided, it will be used. Otherwise, default options will be used.

Order of application of parameters:

  • Custom Doxygen config file

  • If not provided, default options - in documentation

  • New Doxygen config options from mkdocs.yml

  • Overwrite INPUT and OUTPUT_DIRECTORY with the provided values for correct plugin operation.

Overwrite options description:

  • INPUT: <doxygenSource>

  • OUTPUT_DIRECTORY: <tempDoxyFolder>

Default Doxygen config options:

  • DOXYFILE_ENCODING: UTF-8

  • GENERATE_XML: YES

  • RECURSIVE: YES

  • EXAMPLE_PATH: examples

  • SHOW_NAMESPACES: YES

  • GENERATE_HTML: NO

  • GENERATE_LATEX: NO

Parameters:

  • doxyCfgNew (dict) New Doxygen config options that will be added to the default config (new options will overwrite default options)
Returns:

(dict) Doxygen configuration.

function str2dox_dict

Convert a string from a doxygen config file to a dictionary. 

dict mkdoxy::doxyrun::DoxygenRun::str2dox_dict (
    self self,
    str dox_str
)

Parameters:

  • dox_str (str) String from a doxygen config file.
Returns:

(dict) Dictionary.

The documentation for this class was generated from the following file mkdoxy/doxyrun.py