LUFA Library
DMBS - Dean's Makefile Build System

Module: DOXYGEN

The DOXYGEN module provides build targets to automatically generate API documentation for a project, using the open-source Doxygen tool.

Importing This Module into a Makefile:

To use this module in your application makefile, add the following code to your makefile:

include $(DMBS_PATH)/doxygen.mk

Prerequisites:

This module requires the doxygen utility to be available in your system's PATH variable. The doxygen utility is distributed on the project's official site but is also made available in many *nix operating system's package managers.

Build Targets:

The following targets are supported by this module:

doxygen

Generate project documentation, via Doxygen.

doxygen-create

Create a new project Doxygen template, which can then be customized.

doxygen-upgrade

Upgrade an existing project Doxygen template to the latest Doxygen version. </tbody>

Mandatory Variables:

The following variables must be defined (with a NAME = VALUE syntax, one variable per line) in the user makefile to be able to use this module:

N/A

This module has no mandatory variables. </tbody>

Optional Variables:

The following variables may be defined (with a NAME = VALUE syntax, one variable per line) in the user makefile. If not specified, a default value will be assumed.

DOXYGEN_CONF

Name of the Doxygen project configuration file that should be used when generating documentation, or creating/upgrading the configuration file.

DOXYGEN_FAIL_ON_WARNING

Boolean, if Y the build will fail if Doxygen encounters any errors or warnings. If N, fail only on errors. Default is Y.

DOXYGEN_OVERRIDE_PARAMS

List of NAME=VALUE parameters which should override the values specified in the project configuration file, when building documentation. </tbody>

Provided Variables:

The following variables may be referenced in a user makefile (via syntax) if desired, as they are provided by this module.

N/A

This module provides no variables. </tbody>

Provided Macros:

The following macros may be referenced in a user makefile (via $(call NAME, ARG1, ARG2, ...) syntax) if desired, as they are provided by this module.

N/A

This module provides no macros. </tbody>