Re: [Boost-build] [Doxygen] Running Doxygen from BB

Subject: Re: [Boost-build] [Doxygen] Running Doxygen from BB
From: Robert Kawulak (robert.kawulak_at_[hidden])
Date: 2011-07-10 12:04:14

> From: Artyom Beilis
> I use Doxygen for documentation generation.
[...]
> How can this be integrated to the build system of Boost
> documentation generation of Boost?

Assuming you've enabled doxygen in user-config.jam, just make Jamfile.v2
with this:

using doxygen ;
doxygen <output dir>.html : <sources> : <options> ;

I'll paste relevant parts of my jamfile at the end.

Best regards,
Robert

=== CODE ===

using doxygen ;

doxygen reference.html
    :
        ../../../boost/constrained_value.hpp
        [ glob ../../../boost/constrained_value/*.hpp ]
    :
        <doxygen:param>"PROJECT_NAME=\"Boost Constrained Value Library\""
        <doxygen:param>"PROJECT_LOGO=\"$(BOOST_ROOT)/boost.png\""
        # paths
        <doxygen:param>STRIP_FROM_PATH=../../..
        <doxygen:param>STRIP_FROM_INC_PATH=../../..
        <doxygen:param>OUTPUT_DIRECTORY=html
        # messages
        <doxygen:param>QUIET=YES
        <doxygen:param>WARN_IF_UNDOCUMENTED=YES
        <doxygen:param>WARN_IF_DOC_ERROR=YES
        # preprocessing
        <doxygen:param>ENABLE_PREPROCESSING=YES
        <doxygen:param>MACRO_EXPANSION=YES
        <doxygen:param>EXPAND_ONLY_PREDEF=YES
        <doxygen:param>"PREDEFINED=BOOST_CONSTRAINED_VALUE_DOXYGEN_INVOKED
\\
                       \"BOOST_CONSTRAINED_VALUE_SEE_DESCRIPTION=see
description\""
 
<doxygen:param>EXPAND_AS_DEFINED=BOOST_CONSTRAINED_VALUE_DEFINE_ASSIGNMENT_O
PERATOR
        # input
        <doxygen:param>JAVADOC_AUTOBRIEF=YES
        <doxygen:param>EXTRACT_PRIVATE=NO
        <doxygen:param>EXTRACT_STATIC=YES
        <doxygen:param>HIDE_UNDOC_MEMBERS=YES
        <doxygen:param>HIDE_UNDOC_CLASSES=YES
        # output
        <doxygen:param>HIDE_SCOPE_NAMES=YES
        <doxygen:param>INLINE_INFO=NO
        <doxygen:param>SORT_MEMBER_DOCS=NO
        <doxygen:param>SHOW_DIRECTORIES=YES
        <doxygen:param>SOURCE_BROWSER=YES
        <doxygen:param>REFERENCED_BY_RELATION=NO
        <doxygen:param>REFERENCES_RELATION=NO
        <doxygen:param>REFERENCES_LINK_SOURCE=NO
        <doxygen:param>VERBATIM_HEADERS=NO
        <doxygen:param>HIDE_UNDOC_RELATIONS=NO
    ;