Changeset 2733

Show
Ignore:
Timestamp:
01/29/18 02:32:13 (4 months 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 
  • trunk/libffado/doc/SConscript

    r1185 r2733  
    55env = env.Clone() 
    66 
     7# At this point BUILD_DOC is either 'all' or 'user' 
     8doxygen_dir_list = [env["top_srcdir"] + "/libffado"] 
     9if env["BUILD_DOC"] == 'all': 
     10    doxygen_dir_list += [env["top_srcdir"] + "/src", 
     11                         env["top_srcdir"] + "/doc"] 
     12env["DOXYGEN_INPUT"] = " ".join(doxygen_dir_list) 
     13 
    714env.ScanReplace( "reference.doxygen.in" ) 
    815 
  • trunk/libffado/SConstruct

    r2725 r2733  
    7070    BoolVariable( "ENABLE_ALL", "Enable/Disable support for all devices.", False ), 
    7171    BoolVariable( "SERIALIZE_USE_EXPAT", "Use libexpat for XML serialization.", False ), 
     72    EnumVariable( "BUILD_DOC", "Build API documentation", 'none', allowed_values=('all', 'user', 'none'), ignorecase=2), 
    7273    EnumVariable( "BUILD_MIXER", "Build the ffado-mixer", 'auto', allowed_values=('auto', 'true', 'false'), ignorecase=2), 
    7374    BoolVariable( "BUILD_TESTS", """\ 
     
    918919    if env['BUILD_TESTS']: 
    919920        Default( 'tests' ) 
     921    if env['BUILD_DOC'] != 'none': 
     922        Default( 'doc' ) 
    920923 
    921924#