libs/container/doc/Jamfile.v2

   1 #  Boost.Container library documentation Jamfile  ---------------------------------
   2 #
   3 #  Copyright Ion Gaztanaga 2009-2011. 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 : html ;
  16
  17 doxygen autodoc
  18    :
  19       [ glob ../../../boost/container/*.hpp ]
  20    :
  21         <doxygen:param>EXTRACT_ALL=NO
  22         <doxygen:param>HIDE_UNDOC_MEMBERS=YES
  23         <doxygen:param>EXTRACT_PRIVATE=NO
  24         <doxygen:param>ENABLE_PREPROCESSING=YES
  25         <doxygen:param>EXPAND_ONLY_PREDEF=YES
  26         <doxygen:param>MACRO_EXPANSION=YES
  27         <doxygen:param>"PREDEFINED=\"insert_const_ref_type= const T&\" \\
  28                                    \"BOOST_CONTAINER_DOXYGEN_INVOKED\" \\
  29                                    \"BOOST_RV_REF(T)=T &&\" \\
  30                                    \"BOOST_COPY_ASSIGN_REF(T)=const T &\" \\
  31                                    \"BOOST_RV_REF_2_TEMPL_ARGS(T,a,b)=T<a, b> &&\" \\
  32                                    \"BOOST_RV_REF_3_TEMPL_ARGS(T,a,b,c)=T<a,b,c>T<a,b,c> &&\" \\
  33                                    \"BOOST_FWD_REF(a)=a &&\""
  34         <xsl:param>"boost.doxygen.reftitle=Boost.Container Header Reference"
  35    ;
  36
  37 xml container : container.qbk
  38               :
  39                  <include>../../../tools/auto_index/include
  40               ;
  41
  42 boostbook standalone
  43    :
  44       container
  45    :
  46         <xsl:param>boost.root=../../../..
  47         <xsl:param>boost.libraries=../../../../libs/libraries.htm
  48         <xsl:param>generate.section.toc.level=3
  49         <xsl:param>chunk.first.sections=1
  50         <format>pdf:<xsl:param>img.src.path=$(images_location)/
  51         <dependency>autodoc
  52         <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
  53
  54         # Build requirements go here:
  55
  56         # <auto-index>on (or off) one turns on (or off) indexing:
  57         <auto-index>on
  58
  59         # Turns on (or off) auto-index-verbose for diagnostic info.
  60         # This is highly recommended until you have got all the many details correct!
  61         <auto-index-verbose>on
  62
  63         # Choose the indexing method (separately for html and PDF) - see manual.
  64         # Choose indexing method for PDFs:
  65         <format>pdf:<auto-index-internal>off
  66
  67         # Choose indexing method for html:
  68         <format>html:<auto-index-internal>on
  69
  70         # Set the name of the script file to use (index.idx is popular):
  71         <auto-index-script>index.idx
  72         # Commands in the script file should all use RELATIVE PATHS
  73         # otherwise the script will not be portable to other machines.
  74         # Relative paths are normally taken as relative to the location
  75         # of the script file, but we can add a prefix to all
  76         # those relative paths using the <auto-index-prefix> feature.
  77         # The path specified by <auto-index-prefix> may be either relative or
  78         # absolute, for example the following will get us up to the boost root
  79         # directory for most Boost libraries:
  80         <auto-index-prefix>"../../.."
  81
  82    ;