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    :
  22         <doxygen:param>EXTRACT_ALL=NO
  23         <doxygen:param>HIDE_UNDOC_MEMBERS=YES
  24         <doxygen:param>EXTRACT_PRIVATE=NO
  25         <doxygen:param>ENABLE_PREPROCESSING=YES
  26         <doxygen:param>EXPAND_ONLY_PREDEF=YES
  27         <doxygen:param>MACRO_EXPANSION=YES
  28         <doxygen:param>"PREDEFINED=\"insert_const_ref_type= const T&\" \\
  29                                    \"BOOST_CONTAINER_DOXYGEN_INVOKED\" \\
  30                                    \"BOOST_CONTAINER_IMPDEF(T)=implementation_defined\" \\
  31                                    \"BOOST_CONTAINER_SEEDOC(T)=see_documentation\" \\
  32                                    \"BOOST_CONTAINER_NOEXCEPT=noexcept\" \\
  33                                    \"BOOST_CONTAINER_NOEXCEPT_IF(T)=noexcept(T)\" \\
  34                                    \"BOOST_RV_REF(T)=T &&\" \\
  35                                    \"BOOST_RV_REF_BEG=\" \\
  36                                    \"BOOST_RV_REF_END=&&\" \\
  37                                    \"BOOST_COPY_ASSIGN_REF(T)=const T &\" \\
  38                                    \"BOOST_FWD_REF(a)=a &&\" \\
  39                                    \"BOOST_INTRUSIVE_OPTION_CONSTANT(OPTION_NAME, TYPE, VALUE, CONSTANT_NAME)   = template<TYPE VALUE> struct OPTION_NAME{};\" \\
  40                                    \"BOOST_INTRUSIVE_OPTION_TYPE(OPTION_NAME, TYPE, TYPEDEF_EXPR, TYPEDEF_NAME) = template<class TYPE> struct OPTION_NAME{};\"
  41                                    \"BOOST_CONTAINER_DOC1ST(T1, T2)=T1\" \\
  42                                    \"BOOST_CONTAINER_DOCIGN(T) \"\\
  43                                    \"BOOST_CONTAINER_DOCONLY(T) T\"\\
  44                                    "
  45         <xsl:param>"boost.doxygen.reftitle=Boost.Container Header Reference"
  46    ;
  47
  48 xml container : container.qbk
  49               :
  50                  <include>../../../tools/auto_index/include
  51               ;
  52
  53 boostbook standalone
  54    :
  55       container
  56    :
  57         <format>html:<xsl:param>boost.root=../../../..
  58         <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
  59         <format>html:<xsl:param>img.src.path=../../../../doc/html/
  60         <format>xhtml:<xsl:param>img.src.path=../../../../doc/html/
  61         <xsl:param>generate.section.toc.level=3
  62         <xsl:param>chunk.first.sections=1
  63         <format>pdf:<xsl:param>img.src.path=$(images_location)/
  64         <dependency>autodoc
  65         <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
  66
  67         # Build requirements go here:
  68
  69         # <auto-index>on (or off) one turns on (or off) indexing:
  70         <auto-index>on
  71
  72         # Turns on (or off) auto-index-verbose for diagnostic info.
  73         # This is highly recommended until you have got all the many details correct!
  74         <auto-index-verbose>on
  75
  76         # Choose the indexing method (separately for html and PDF) - see manual.
  77         # Choose indexing method for PDFs:
  78         <format>pdf:<auto-index-internal>off
  79
  80         # Choose indexing method for html:
  81         <format>html:<auto-index-internal>on
  82         <format>docbook:<auto-index-internal>on
  83
  84         # Set the name of the script file to use (index.idx is popular):
  85         <auto-index-script>$(here)/index.idx
  86         # Commands in the script file should all use RELATIVE PATHS
  87         # otherwise the script will not be portable to other machines.
  88         # Relative paths are normally taken as relative to the location
  89         # of the script file, but we can add a prefix to all
  90         # those relative paths using the <auto-index-prefix> feature.
  91         # The path specified by <auto-index-prefix> may be either relative or
  92         # absolute, for example the following will get us up to the boost root
  93         # directory for most Boost libraries:
  94         <auto-index-prefix>"$(here)/../../.."
  95
  96         <format>pdf:<xsl:param>admon.graphics.extension=".svg"
  97    ;
  98
  99 install pdfinstall : standalone/<format>pdf : <install-type>PDF <location>. <name>container.pdf ;
 100 explicit pdfinstall ;
 101
 102