Build System Document Generation Module

Overview

The Build System Document Generation Module provides the build system with the ability to generate documents from other sources. This includes the ability to run doxygen and javadoc (although javadoc has yet to be implemented).

Macros and Controls

Targets

DOXYGEN_TARGETS

DOXYGEN_TARGETS Overview

DOXYGEN_TARGETS is the doxygen (http://www.doxyten.org/) pattern target. This pattern target is used to produce documents from source code and doxygen configuration files. DOXYGEN_TARGETS will be build during the "target" phase of a build. The general form of the doxygen command used to generate documents is as follows:
<doxygen> <doxygen flags> <doxygen config file>

The <doxygen flags> used to build the source code file are assembled from the following macros in the indicated order:

FLAGS_DOXYGEN

DOXYGEN_TARGETS Options

<doxygen target>_DOXYGEN
Override the default doxygen binary for the current target.

<doxygen target>_DOXYGENFLAGS
Override FLAGS_DOXYGEN for the current <doxygen target>.

<doxygen target>_DEP
Specify additional dependancies for the current <doxygen target>.

<doxy target>_SRC
Override the default config file, "Doxyfile".

doc_doxygen

doc_doxygen Overview

Simple target to trigger the building of DOXYGEN_TARGETS pattern targets independent of the main build "target" phase.

doc_info

doc_info Overview

Simple target to display information about the macro settings of all global macros used by the document generation module of the build system. The doc_info target will be built during the "info" phase of a build, and can be built in isolation by requesting the doc_info target.

doc_man

doc_man Overview

Simple targes to display usage information and help pertaining to the document generation module of the build system. The doc_man target will be built during the "man" phase of a build, and can be built in isolation by requesting the doc_man target.

Example Makefile


# The source root of this Component
COMPONENT_ROOT=../..

# The root of the build system
BS_ROOT=$(COMPONENT_ROOT)/../build3

# Boostrap Build system definitions.
include $(BS_ROOT)/defines.mk

# Generate src code from lex code.
DOXYGEN_TARGETS=my_project_doxgen_docs

my_project_doxygen_docs_SRC=my_project_Doxyfile

include $(BS_ROOT)/rules.mk