1#  Boost.Intrusive library documentation Jamfile
2#
3#  Copyright Ion Gaztanaga 2006.
4#  Distributed under the Boost Software License, Version 1.0.
5#     (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/libs/intrusive for documentation.
9
10using auto-index ;
11
12import doxygen ;
13import quickbook ;
14path-constant here : . ;
15
16
17
18doxygen autodoc
19   :
20      [ glob ../../../boost/intrusive/*.hpp ]
21   :
22   <doxygen:param>HIDE_UNDOC_MEMBERS=YES
23   <doxygen:param>HIDE_UNDOC_MEMBERS=YES
24   <doxygen:param>HIDE_UNDOC_CLASSES=YES
25   <doxygen:param>EXTRACT_PRIVATE=NO
26   <doxygen:param>ENABLE_PREPROCESSING=YES
27   <doxygen:param>MACRO_EXPANSION=YES
28   <doxygen:param>"PREDEFINED=\"BOOST_INTRUSIVE_DOXYGEN_INVOKED\" \\
29                  \"BOOST_INTRUSIVE_IMPDEF(T)=implementation_defined\" \\
30                  \"BOOST_INTRUSIVE_SEEDOC(T)=see_documentation\" \\
31                  \"BOOST_INTRUSIVE_DOC1ST(T1,T2)=T1\" \\
32                  \"BOOST_INTRUSIVE_DOCIGN(T)=\" \\
33                  \"BOOST_INTRUSIVE_I(T)=,\" \\
34                  \"BOOST_RV_REF(T)=T &&\" \\
35                  \"BOOST_RV_REF_BEG=\" \\
36                  \"BOOST_RV_REF_END=&&\" \\
37                  \"BOOST_INTRUSIVE_FORCEINLINE=inline\" \\
38                  \"list_impl=list\" \\
39                  \"slist_impl=slist\" \\
40                  \"bstree_impl=bstree\" \\
41                  \"bs_set_impl=bs_set\" \\
42                  \"bs_multiset_impl=bs_multiset\" \\
43                  \"rbtree_impl=rbtree\" \\
44                  \"set_impl=set\" \\
45                  \"multiset_impl=multiset\" \\
46                  \"unordered_set_impl=unordered_set\" \\
47                  \"unordered_multiset_impl=unordered_multiset\" \\
48                  \"hashtable_impl=hashtable\" \\
49                  \"splay_set_impl=splay_set\" \\
50                  \"splay_multiset_impl=splay_multiset\" \\
51                  \"splaytree_impl=splaytree\" \\
52                  \"sg_set_impl=sg_set\" \\
53                  \"sg_multiset_impl=sg_multiset\" \\
54                  \"sgtree_impl=sgtree\" \\
55                  \"avl_set_impl=avl_set\" \\
56                  \"avl_multiset_impl=avl_multiset\" \\
57                  \"avltree_impl=avltree\" \\
58                  \"treap_set_impl=treap_set\" \\
59                  \"treap_multiset_impl=treap_multiset\" \\
60                  \"treap_impl=treap\" \\
61                  \"BOOST_INTRUSIVE_OPTION_CONSTANT(OPTION_NAME, TYPE, VALUE, CONSTANT_NAME)   = template<TYPE VALUE> struct OPTION_NAME{};\" \\
62                  \"BOOST_INTRUSIVE_OPTION_TYPE(OPTION_NAME, TYPE, TYPEDEF_EXPR, TYPEDEF_NAME) = template<class TYPE> struct OPTION_NAME{};\" "
63   ;
64
65xml intrusive : intrusive.qbk
66              :
67                 <include>../../../tools/auto_index/include
68              ;
69
70boostbook standalone
71   :
72      intrusive
73   :
74        <format>html:<xsl:param>boost.root=../../../..
75        <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
76        <xsl:param>generate.section.toc.level=3
77        <xsl:param>chunk.first.sections=1
78        <dependency>autodoc
79
80        # Build requirements go here:
81
82        # <auto-index>on (or off) one turns on (or off) indexing:
83        <auto-index>on
84
85        # Turns on (or off) auto-index-verbose for diagnostic info.
86        # This is highly recommended until you have got all the many details correct!
87        <auto-index-verbose>on
88
89        # Choose the indexing method (separately for html and PDF) - see manual.
90        # Choose indexing method for PDFs:
91        <format>pdf:<auto-index-internal>off
92
93        # Choose indexing method for html:
94        <format>html:<auto-index-internal>on
95        <format>docbook:<auto-index-internal>on
96
97        # Set the name of the script file to use (index.idx is popular):
98        <auto-index-script>$(here)/index.idx
99        # Commands in the script file should all use RELATIVE PATHS
100        # otherwise the script will not be portable to other machines.
101        # Relative paths are normally taken as relative to the location
102        # of the script file, but we can add a prefix to all
103        # those relative paths using the <auto-index-prefix> feature.
104        # The path specified by <auto-index-prefix> may be either relative or
105        # absolute, for example the following will get us up to the boost root
106        # directory for most Boost libraries:
107        <auto-index-prefix>"$(here)/../../.."
108
109   ;
110
111install pdfinstall : standalone/<format>pdf : <name>intrusive.pdf <location>. <install-type>PDF <format>pdf ;
112explicit pdfinstall ;
113
114###############################################################################
115alias boostdoc
116    : standalone/<format>docbook
117    :
118    :
119    : ;
120explicit boostdoc ;
121alias boostrelease ;
122explicit boostrelease ;
123