Show
Ignore:
Timestamp:
01/29/18 02:32:13 (6 years ago)
Author:
jwoithe
Message:

Add build-time control over documentation generation.

Up to this point, FFADO documentation has always been generated when
doxygen is on the system. Furthermore, the documentation included internal
API details which are not of any interest to users of FFADO.

This patch from Orcan Ogetbil (via ffado-devel) adds the BUILD_DOC scons
parameter which takes one of three values: "none" (don't build any
documentation), "user" (build documentation of interest to users of FFADO)
and "all" (build all documentation). The default is "none", mostly because
Orcan's distribution (Fedora) has traditionally patched
doc/reference.doxygen.in to exclude documentation. This is fine since the
documentation is not of interest to a vast majority of people.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/libffado/doc/reference.doxygen.in

    r1753 r2733  
    569569# with spaces. 
    570570 
    571 INPUT                  = $top_srcdir/src \ 
    572                          $top_srcdir/doc \ 
    573                          $top_srcdir/libffado 
     571INPUT                  = $DOXYGEN_INPUT 
    574572 
    575573# This tag can be used to specify the character encoding of the source files