1# Boost.Interprocess library documentation Jamfile --------------------------------- 2# 3# Copyright Ion Gaztanaga 2005-2009. 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 10using auto-index ; 11 12import doxygen ; 13import quickbook ; 14path-constant here : . ; 15 16doxygen autodoc 17 : 18 [ glob ../../../boost/interprocess/*.hpp ] 19 [ glob ../../../boost/interprocess/allocators/*.hpp ] 20 [ glob ../../../boost/interprocess/containers/*.hpp ] 21 [ glob ../../../boost/interprocess/indexes/*.hpp ] 22 [ glob ../../../boost/interprocess/ipc/*.hpp ] 23 [ glob ../../../boost/interprocess/mem_algo/*.hpp ] 24 [ glob ../../../boost/interprocess/smart_ptr/*.hpp ] 25 [ glob ../../../boost/interprocess/streams/*.hpp ] 26 [ glob ../../../boost/interprocess/sync/*.hpp ] 27 : 28 <doxygen:param>EXTRACT_ALL=NO 29 <doxygen:param>HIDE_UNDOC_MEMBERS=YES 30 <doxygen:param>EXTRACT_PRIVATE=NO 31 <doxygen:param>ENABLE_PREPROCESSING=YES 32 <doxygen:param>EXPAND_ONLY_PREDEF=YES 33 <doxygen:param>MACRO_EXPANSION=YES 34 <doxygen:param>"PREDEFINED=\"BOOST_INTERPROCESS_DOXYGEN_INVOKED\" \\ 35 \"BOOST_NOEXCEPT_IF(T)=noexcept(T)\" \\ 36 \"BOOST_NOEXCEPT_OR_NOTHROW=noexcept\" \\ 37 \"BOOST_INTERPROCESS_IMPDEF(T)=implementation_defined\" \\ 38 \"BOOST_INTERPROCESS_SEEDOC(T)=see_documentation\" \\ 39 \"BOOST_INTERPROCESS_DOC1ST(T1,T2)=T1\" \\ 40 \"BOOST_INTERPROCESS_DOCIGN(T)=\" \\ 41 \"BOOST_INTERPROCESS_I(T)=,\" \\ 42 \"BOOST_INTERPROCESS_ENABLE_MOVE_EMULATION(a)= \" \\ 43 \"BOOST_RV_REF(T)=T&&\" \\ 44 \"BOOST_RV_REF_BEG=\" \\ 45 \"BOOST_RV_REF_END=&&\" \\ 46 \"BOOST_FWD_REF(T)=T&&\" \\ 47 \"BOOST_INTERPROCESS_FORCEINLINE=inline\" \\ 48 " 49 50 <xsl:param>"boost.doxygen.reftitle=Boost.Interprocess Header Reference" 51 ; 52 53xml interprocess : interprocess.qbk 54 : 55 <include>../../../tools/auto_index/include 56 ; 57 58boostbook standalone 59 : 60 interprocess 61 : 62 <format>html:<xsl:param>boost.root=../../../.. 63 <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm 64 <xsl:param>generate.section.toc.level=3 65 <xsl:param>chunk.first.sections=1 66 <dependency>autodoc 67 <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html 68 # Build requirements go here: 69 70 # <auto-index>on (or off) one turns on (or off) indexing: 71 <auto-index>on 72 73 # Turns on (or off) auto-index-verbose for diagnostic info. 74 # This is highly recommended until you have got all the many details correct! 75 <auto-index-verbose>on 76 77 # Choose the indexing method (separately for html and PDF) - see manual. 78 # Choose indexing method for PDFs: 79 <format>pdf:<auto-index-internal>off 80 81 # Choose indexing method for html: 82 <format>html:<auto-index-internal>on 83 <format>docbook:<auto-index-internal>on 84 85 # Set the name of the script file to use (index.idx is popular): 86 <auto-index-script>$(here)/index.idx 87 # Commands in the script file should all use RELATIVE PATHS 88 # otherwise the script will not be portable to other machines. 89 # Relative paths are normally taken as relative to the location 90 # of the script file, but we can add a prefix to all 91 # those relative paths using the <auto-index-prefix> feature. 92 # The path specified by <auto-index-prefix> may be either relative or 93 # absolute, for example the following will get us up to the boost root 94 # directory for most Boost libraries: 95 <auto-index-prefix>"$(here)/../../.." 96 97 ; 98 99install pdfinstall : standalone/<format>pdf : <location>. <name>interprocess.pdf <install-type>PDF <format>pdf ; 100explicit pdfinstall ; 101 102############################################################################### 103alias boostdoc 104 : standalone/<format>docbook 105 : 106 : 107 : ; 108explicit boostdoc ; 109alias boostrelease ; 110explicit boostrelease ; 111