summaryrefslogtreecommitdiff
path: root/libs/interprocess/doc/Jamfile.v2
blob: d35a64800c97b327bb61b43936d46e4495cb22cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#  Boost.Interprocess library documentation Jamfile  ---------------------------------
#
#  Copyright Ion Gaztanaga 2005-2009. Use, modification and
#  distribution is subject to the Boost Software License, Version
#  1.0. (See accompanying file LICENSE_1_0.txt or copy at
#  http://www.boost.org/LICENSE_1_0.txt)
#
#  See http://www.boost.org for updates, documentation, and revision history.

using auto-index ;

import doxygen ;
import quickbook ;
path-constant here : . ;

doxygen autodoc
   :
      [ glob ../../../boost/interprocess/*.hpp ]
      [ glob ../../../boost/interprocess/allocators/*.hpp ]
      [ glob ../../../boost/interprocess/containers/*.hpp ]
      [ glob ../../../boost/interprocess/indexes/*.hpp ]
      [ glob ../../../boost/interprocess/ipc/*.hpp ]
      [ glob ../../../boost/interprocess/mem_algo/*.hpp ]
      [ glob ../../../boost/interprocess/smart_ptr/*.hpp ]
      [ glob ../../../boost/interprocess/streams/*.hpp ]
      [ glob ../../../boost/interprocess/sync/*.hpp ]
   :
        <doxygen:param>EXTRACT_ALL=NO
        <doxygen:param>HIDE_UNDOC_MEMBERS=YES
        <doxygen:param>EXTRACT_PRIVATE=NO
        <doxygen:param>ENABLE_PREPROCESSING=YES
        <doxygen:param>EXPAND_ONLY_PREDEF=YES
        <doxygen:param>MACRO_EXPANSION=YES
        <doxygen:param>"PREDEFINED=\"BOOST_INTERPROCESS_DOXYGEN_INVOKED\" \\
                                   \"BOOST_NOEXCEPT_IF(T)=noexcept(T)\" \\
                                   \"BOOST_NOEXCEPT_OR_NOTHROW=noexcept\" \\
                                   \"BOOST_INTERPROCESS_IMPDEF(T)=implementation_defined\" \\
                                   \"BOOST_INTERPROCESS_SEEDOC(T)=see_documentation\" \\
                                   \"BOOST_INTERPROCESS_ENABLE_MOVE_EMULATION(a)= \" \\
                                   \"BOOST_RV_REF(T)=T&&\" \\
                                   \"BOOST_RV_REF_BEG=\" \\
                                   \"BOOST_RV_REF_END=&&\" \\
                                   \"BOOST_FWD_REF(T)=T&&\""

        <xsl:param>"boost.doxygen.reftitle=Boost.Interprocess Header Reference"
   ;

xml interprocess : interprocess.qbk
              :
                 <include>../../../tools/auto_index/include
              ;

boostbook standalone
   :
      interprocess
   :
        <format>html:<xsl:param>boost.root=../../../..
        <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
        <xsl:param>generate.section.toc.level=3
        <xsl:param>chunk.first.sections=1
        <dependency>autodoc
        <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
        # Build requirements go here:

        # <auto-index>on (or off) one turns on (or off) indexing:
        <auto-index>on

        # Turns on (or off) auto-index-verbose for diagnostic info.
        # This is highly recommended until you have got all the many details correct!
        <auto-index-verbose>on

        # Choose the indexing method (separately for html and PDF) - see manual.
        # Choose indexing method for PDFs:
        <format>pdf:<auto-index-internal>off

        # Choose indexing method for html:
        <format>html:<auto-index-internal>on
        <format>docbook:<auto-index-internal>on

        # Set the name of the script file to use (index.idx is popular):
        <auto-index-script>$(here)/index.idx
        # Commands in the script file should all use RELATIVE PATHS
        # otherwise the script will not be portable to other machines.
        # Relative paths are normally taken as relative to the location
        # of the script file, but we can add a prefix to all
        # those relative paths using the <auto-index-prefix> feature.
        # The path specified by <auto-index-prefix> may be either relative or
        # absolute, for example the following will get us up to the boost root
        # directory for most Boost libraries:
        <auto-index-prefix>"$(here)/../../.."

   ;

install pdfinstall : standalone/<format>pdf : <location>. <name>interprocess.pdf <install-type>PDF <format>pdf ;
explicit pdfinstall ;