1#  Boost.Container library documentation Jamfile  ---------------------------------
2#
3#  Copyright Ion Gaztanaga 2009-2013. Use, modification and
4#  distribution is subject to the Boost Software License, Version
5#  1.0. (See accompanying file LICENSE_1_0.txt or copy at
6#  http://www.boost.org/LICENSE_1_0.txt)
7#
8#  See http://www.boost.org for updates, documentation, and revision history.
9
10import doxygen ;
11import quickbook ;
12
13using auto-index ;
14
15path-constant images_location : ../ ;
16path-constant here : . ;
17
18doxygen autodoc
19   :
20      [ glob ../../../boost/container/*.hpp ]
21      [ glob ../../../boost/container/pmr/*.hpp ]
22   :
23        <doxygen:param>EXTRACT_ALL=NO
24        <doxygen:param>HIDE_UNDOC_MEMBERS=YES
25        <doxygen:param>EXTRACT_PRIVATE=NO
26        <doxygen:param>ENABLE_PREPROCESSING=YES
27        <doxygen:param>EXPAND_ONLY_PREDEF=YES
28        <doxygen:param>MACRO_EXPANSION=YES
29        <doxygen:param>"PREDEFINED=\"insert_const_ref_type= const T&\" \\
30                                   \"BOOST_CONSTEXPR_OR_CONST=constexpr\" \\
31                                   \"BOOST_CONTAINER_DOXYGEN_INVOKED\" \\
32                                   \"BOOST_CONTAINER_IMPDEF(T)=implementation_defined\" \\
33                                   \"BOOST_CONTAINER_SEEDOC(T)=see_documentation\" \\
34                                   \"BOOST_NOEXCEPT_OR_NOTHROW=noexcept\" \\
35                                   \"BOOST_NOEXCEPT_IF(T)=noexcept(T)\" \\
36                                   \"BOOST_RV_REF(T)=T&&\" \\
37                                   \"BOOST_RV_REF_BEG=\" \\
38                                   \"BOOST_RV_REF_END=&&\" \\
39                                   \"BOOST_RV_REF_BEG_IF_CXX11=\" \\
40                                   \"BOOST_RV_REF_END_IF_CXX11=&&\" \\
41                                   \"BOOST_COPY_ASSIGN_REF(T)=const T &\" \\
42                                   \"BOOST_FWD_REF(a)=a &&\" \\
43                                   \"BOOST_CONTAINER_ATTRIBUTE_NODISCARD=[[nodiscard]] \" \\
44                                   \"BOOST_NORETURN=[[noreturn]] \" \\
45                                   \"BOOST_INTRUSIVE_OPTION_CONSTANT(OPTION_NAME, TYPE, VALUE, CONSTANT_NAME)   = template<TYPE VALUE> struct OPTION_NAME{};\" \\
46                                   \"BOOST_INTRUSIVE_OPTION_TYPE(OPTION_NAME, TYPE, TYPEDEF_EXPR, TYPEDEF_NAME) = template<class TYPE> struct OPTION_NAME{};\" \\
47                                   \"BOOST_CONTAINER_DOC1ST(T1, T2)=T1\" \\
48                                   \"BOOST_CONTAINER_DOCIGN(T) \"\\
49                                   \"BOOST_CONTAINER_DOCONLY(T)=T\"\\
50                                   \"BOOST_CONTAINER_SCOPEDALLOC_DUMMYTRUE=\"\\
51                                   \"BOOST_CONTAINER_SCOPEDALLOC_ALLINNER=InnerAllocs...\"\\
52                                   \"BOOST_CONTAINER_DECL=\"\\
53                                   \"BOOST_CONTAINER_FORCEINLINE=inline\" \\
54                                   "
55        <xsl:param>"boost.doxygen.reftitle=Boost.Container Header Reference"
56   ;
57
58xml container : container.qbk
59              :
60                 <include>../../../tools/auto_index/include
61              ;
62
63boostbook standalone
64   :
65      container
66   :
67        <format>html:<xsl:param>boost.root=../../../..
68        <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
69        <format>html:<xsl:param>img.src.path=../../../../doc/html/
70        <format>xhtml:<xsl:param>img.src.path=../../../../doc/html/
71        <xsl:param>generate.section.toc.level=3
72        <xsl:param>chunk.first.sections=1
73        <format>pdf:<xsl:param>img.src.path=$(images_location)/
74        <dependency>autodoc
75        <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
76
77        # Build requirements go here:
78
79        # <auto-index>on (or off) one turns on (or off) indexing:
80        <auto-index>on
81
82        # Turns on (or off) auto-index-verbose for diagnostic info.
83        # This is highly recommended until you have got all the many details correct!
84        <auto-index-verbose>on
85
86        # Choose the indexing method (separately for html and PDF) - see manual.
87        # Choose indexing method for PDFs:
88        <format>pdf:<auto-index-internal>off
89
90        # Choose indexing method for html:
91        <format>html:<auto-index-internal>on
92        <format>docbook:<auto-index-internal>on
93
94        # Set the name of the script file to use (index.idx is popular):
95        <auto-index-script>$(here)/index.idx
96        # Commands in the script file should all use RELATIVE PATHS
97        # otherwise the script will not be portable to other machines.
98        # Relative paths are normally taken as relative to the location
99        # of the script file, but we can add a prefix to all
100        # those relative paths using the <auto-index-prefix> feature.
101        # The path specified by <auto-index-prefix> may be either relative or
102        # absolute, for example the following will get us up to the boost root
103        # directory for most Boost libraries:
104        <auto-index-prefix>"$(here)/../../.."
105
106        <format>pdf:<xsl:param>admon.graphics.extension=".svg"
107   ;
108
109install pdfinstall : standalone/<format>pdf : <install-type>PDF <location>. <name>container.pdf ;
110explicit pdfinstall ;
111
112###############################################################################
113alias boostdoc
114    : standalone/<format>docbook
115    :
116    :
117    : ;
118explicit boostdoc ;
119alias boostrelease ;
120explicit boostrelease ;
121