• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1
2# Copyright (C) 2008-2018 Lorenzo Caminiti
3# Distributed under the Boost Software License, Version 1.0 (see accompanying
4# file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt).
5# See: http://www.boost.org/doc/libs/release/libs/contract/doc/html/index.html
6
7using quickbook ;
8using boostbook ;
9using doxygen ;
10
11path-constant images_location : html ;
12path-constant here : . ;
13
14doxygen reference
15:
16    [ glob
17    ../include/boost/contract.hpp
18    ../include/boost/contract_macro.hpp
19
20    ../include/boost/contract/assert.hpp
21    ../include/boost/contract/base_types.hpp
22    ../include/boost/contract/call_if.hpp
23    ../include/boost/contract/check.hpp
24    ../include/boost/contract/constructor.hpp
25    ../include/boost/contract/destructor.hpp
26    ../include/boost/contract/function.hpp
27    ../include/boost/contract/old.hpp
28    ../include/boost/contract/override.hpp
29    ../include/boost/contract/public_function.hpp
30
31    ../include/boost/contract/core/access.hpp
32    ../include/boost/contract/core/check_macro.hpp
33    ../include/boost/contract/core/config.hpp
34    ../include/boost/contract/core/constructor_precondition.hpp
35    ../include/boost/contract/core/exception.hpp
36    ../include/boost/contract/core/specify.hpp
37    ../include/boost/contract/core/virtual.hpp
38    ]
39:
40    <reftitle>"Reference"
41    # Quickbook's Doxygen does not show destructor exception specs.
42    <doxygen:param>PREDEFINED="BOOST_CONTRACT_DETAIL_DOXYGEN BOOST_PP_VARIADICS"
43    <doxygen:param>MACRO_EXPANSION=YES
44    <doxygen:param>INCLUDE_PATH="../include"
45    <doxygen:param>QUIET=YES
46    <doxygen:param>JAVADOC_AUTOBRIEF=YES
47    <doxygen:param>WARN_IF_UNDOCUMENTED=NO
48    <doxygen:param>EXCLUDE_SYMBOLS=std
49    # Following does not work for XML output... use @cond and/or
50    # #ifdef BOOST_CONTRACT_DETAIL_DOXYGEN in code instead.
51    <doxygen:param>EXTRACT_PRIVATE=NO
52    <doxygen:param>HIDE_UNDOC_MEMBERS=YES
53    <doxygen:param>HIDE_UNDOC_CLASSES=YES
54    <doxygen:param>SHORT_NAMES=NO
55    <doxygen:param>ALIASES=" RefSect{2}=\"\\xmlonly<link linkend='boost_contract.\\1'>\\2</link>\\endxmlonly\" RefClass{1}=\"\\xmlonly<computeroutput><classname alt='\\1'>\\1</classname></computeroutput>\\endxmlonly\" RefFunc{1}=\"\\xmlonly<computeroutput><functionname alt='\\1'>\\1</functionname></computeroutput>\\endxmlonly\" RefMacro{1}=\"\\xmlonly<computeroutput><macroname alt='\\1'>\\1</macroname></computeroutput>\\endxmlonly\" RefEnum{1}=\"\\xmlonly<computeroutput><enumname alt='\\1'>\\1</enumname></computeroutput>\\endxmlonly\" "
56;
57
58xml contract : main.qbk : <dependency>reference ;
59
60boostbook boostrelease : contract
61:
62    <location>html
63    <xsl:param>boost.defaults=Boost
64    <xsl:param>boost.root=../../../..
65    <xsl:param>toc.max.depth=1
66    <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/contract/doc/html
67    <format>pdf:<xsl:param>admon.graphics.extension=".svg"
68    <format>pdf:<xsl:param>img.src.path=$(images_location)/
69    <format>pdf:<xsl:param>draft.mode="no"
70
71;
72
73install pdfinstall : doc/<format>pdf :
74        <location>. <install-type>PDF <name>local_function.pdf ;
75explicit pdfinstall ;
76
77