Re: [Boost-build] Doxygen and XML/BoostBook documentation

Subject: Re: [Boost-build] Doxygen and XML/BoostBook documentation
From: Phillip Seaver (phil_at_[hidden])
Date: 2009-02-26 14:31:02

Anthony Foglia wrote:
>     We've been successfully using boost.build to generate Doxygen
> documentation in HTML format, but I'm having trouble getting any other
> format.  I was hoping for PDF, but doxygen.jam in V2 (Milestone 12)
> only claims to support HTML and XML, and only the HTML seems to work.
> (Boostbook might be fine, once I figure out how convert it to PDF.)
>
> Here are the relevant lines from our Jamroot :
> --- Jamroot ---
> project
>    : requirements
>          <threading>multi
>    ;
>
> path-constant TOPDIR : . ;
>
> using doxygen ;
> doxygen documentation.xml
>    : [ path.glob-tree $(TOPDIR)/lib $(TOPDIR)/Distribution
>          : *.h : .svn Sandbox ]
>    :
>      <doxgyen:param>INCLUDE_GRAPH=YES
>      # other <doxygen:param>'s omitted...
>      <location>$(TOPDIR)/doxygen/cpp
>    ;
> --- end --- 

I generate html (with "doxygen foo.html") then use LaTeX to create the
PDF.  Here are (I believe) all the relevant doxygen parameters:

    # generate LaTeX output (used to create PDF)
    GENERATE_LATEX=YES
    # set output sub-directory to "latex"
    LATEX_OUTPUT=latex
    # command to run for latex
    LATEX_CMD_NAME=latex
    # paper size to use in latex output
    PAPER_TYPE=letter
    # "The PDF file will contain links (just like the HTML output) instead
    # of page references"
    PDF_HYPERLINKS=YES
    # "doxygen will use pdflatex to generate the PDF file directly from the
    # LaTeX files."
    USE_PDFLATEX=YES

This creates a "latex" subdirectory in the same directory as the output
html.  If you have the right software installed, you can simply run
"make" in that directory to create the PDF (which will be named refman.pdf).

You need Ghostscript and LaTeX.  This page talks about other tools
needed:  http://www.stack.nl/~dimitri/doxygen/install.html  On Windows,
I use MiKTeX and Ghostscript (along with cygwin to give me "make").

Hope that helps.

Phillip