ceph/src/boost/libs/container/doc/Jamfile.v2

   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
  10 import doxygen ;
  11 import quickbook ;
  12
  13 using auto-index ;
  14
  15 path-constant images_location : ../ ;
  16 path-constant here : . ;
  17
  18 doxygen 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_INTRUSIVE_OPTION_CONSTANT(OPTION_NAME, TYPE, VALUE, CONSTANT_NAME) = template<TYPE VALUE> struct OPTION_NAME{};\" \\
  44                                    \"BOOST_CONTAINER_DOC1ST(T1, T2)=T1\" \\
  45                                    \"BOOST_CONTAINER_DOCIGN(T) \"\\
  46                                    \"BOOST_CONTAINER_DOCONLY(T)=T\"\\
  47                                    \"BOOST_CONTAINER_SCOPEDALLOC_DUMMYTRUE=\"\\
  48                                    \"BOOST_CONTAINER_SCOPEDALLOC_ALLINNER=InnerAllocs...\"\\
  49                                    \"BOOST_CONTAINER_DECL=\"\\
  50                                    \"BOOST_CONTAINER_FORCEINLINE=inline\" \\
  51                                    "
  52         <xsl:param>"boost.doxygen.reftitle=Boost.Container Header Reference"
  53    ;
  54
  55 xml container : container.qbk
  56               :
  57                  <include>../../../tools/auto_index/include
  58               ;
  59
  60 boostbook standalone
  61    :
  62       container
  63    :
  64         <format>html:<xsl:param>boost.root=../../../..
  65         <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
  66         <format>html:<xsl:param>img.src.path=../../../../doc/html/
  67         <format>xhtml:<xsl:param>img.src.path=../../../../doc/html/
  68         <xsl:param>generate.section.toc.level=3
  69         <xsl:param>chunk.first.sections=1
  70         <format>pdf:<xsl:param>img.src.path=$(images_location)/
  71         <dependency>autodoc
  72         <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
  73
  74         # Build requirements go here:
  75
  76         # <auto-index>on (or off) one turns on (or off) indexing:
  77         <auto-index>on
  78
  79         # Turns on (or off) auto-index-verbose for diagnostic info.
  80         # This is highly recommended until you have got all the many details correct!
  81         <auto-index-verbose>on
  82
  83         # Choose the indexing method (separately for html and PDF) - see manual.
  84         # Choose indexing method for PDFs:
  85         <format>pdf:<auto-index-internal>off
  86
  87         # Choose indexing method for html:
  88         <format>html:<auto-index-internal>on
  89         <format>docbook:<auto-index-internal>on
  90
  91         # Set the name of the script file to use (index.idx is popular):
  92         <auto-index-script>$(here)/index.idx
  93         # Commands in the script file should all use RELATIVE PATHS
  94         # otherwise the script will not be portable to other machines.
  95         # Relative paths are normally taken as relative to the location
  96         # of the script file, but we can add a prefix to all
  97         # those relative paths using the <auto-index-prefix> feature.
  98         # The path specified by <auto-index-prefix> may be either relative or
  99         # absolute, for example the following will get us up to the boost root
 100         # directory for most Boost libraries:
 101         <auto-index-prefix>"$(here)/../../.."
 102
 103         <format>pdf:<xsl:param>admon.graphics.extension=".svg"
 104    ;
 105
 106 install pdfinstall : standalone/<format>pdf : <install-type>PDF <location>. <name>container.pdf ;
 107 explicit pdfinstall ;
 108
 109 ###############################################################################
 110 alias boostdoc
 111     : standalone/<format>docbook
 112     :
 113     :
 114     : ;
 115 explicit boostdoc ;
 116 alias boostrelease ;
 117 explicit boostrelease ;