1# Boost.Pool library documentation Jamfile.v2 2# 3# Copyright Paul A. Bristow 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 10local BOOST = $(BOOST_ROOT) ; 11BOOST ?= [ modules.peek : BOOST_ROOT ] ; 12BOOST ?= [ modules.peek : BOOST ] ; 13path-constant boost-root : $(BOOST) ; 14path-constant images_location : images ; # location of SVG and PNG images referenced by Quickbook. 15 16import modules ; 17 18using doxygen ; # Required if you want to use Doxygen. 19using quickbook ; 20 21doxygen autodoc 22 : 23 [ glob ../../../boost/pool/*.hpp ] 24 #[ glob ../../../boost/pool/detail/*.hpp ] 25 #[ glob ../../../boost/pool/detail/*.ipp ] 26 # Renamed as .inc are not recognised correctly by doxywizard leaving error message. 27 # Warning: include file boost/pool/detail/pool_construct.inc not found, perhaps you forgot to add its directory to INCLUDE_PATH? 28 # and problem with 'no type' in jamfile. 29 # error: target { ../../../boost/pool/detail/pool_construct.inc. } has no type 30 31 #[ glob ../../../boost/pool/examples/*.*pp ] # Example source files. 32 : 33 <doxygen:param>WARNINGS=YES # Default NO, but useful to see warnings, especially in a logfile. 34 # It is also wise to to set a warnings logfile like this: 35 <doxygen:param>WARN_LOGFILE=AutoDoxywarnings.log # This may not be empty (usually not a good sign!), depending on options chosen. 36 # Much better to send message to a logfile than the default stderr. 37 # and make sure that there are no Doxygen errors or significant warnings in the log file. 38 <doxygen:param>RECURSIVE=NO # Search recursively down subdirectories. 39 <doxygen:param>EXTRACT_ALL=NO 40 <doxygen:param>HIDE_UNDOC_MEMBERS=YES 41 <doxygen:param>EXTRACT_PRIVATE=NO 42 <doxygen:param>MACRO_EXPANSION=YES 43 <doxygen:param>EXPAND_ONLY_PREDEF=YES 44 <doxygen:param>PREDEFINED="\"BOOST_PREVENT_MACRO_SUBSTITUTION=\" \"BOOST_STATIC_CONSTANT(t,v)=static const t v\" \"BOOST_DOXYGEN=1\"" 45 <xsl:param>"boost.doxygen.reftitle=Boost.Pool C++ Reference" 46 ; 47 48xml pool : pool.qbk : <include>$(boost-root)/tools/auto_index/include ; 49 50boostbook standalone 51 : 52 pool 53 : 54 55 # General settings 56 # ================= 57 # Options for html and pdf 58 # ======================== 59 # No indent on body text: 60 <xsl:param>body.start.indent=0pt 61 # Margin size: 62 <xsl:param>page.margin.inner=0.5in 63 # Margin size: 64 <xsl:param>page.margin.outer=0.5in 65 # Yes, we want graphics for admonishments: 66 <xsl:param>admon.graphics=1 67 # Path for links to Boost: 68 <xsl:param>boost.root=../../../.. 69 70 # HTML options: 71 # ============= 72 # Use graphics icons not text for navigation: 73 <xsl:param>navig.graphics=1 74 # How far down we chunk nested sections, basically all of them: 75 <xsl:param>chunk.section.depth=2 76 # Don't put the first section on the same page as the TOC itself: 77 <xsl:param>chunk.first.sections=1 78 # How far down sections get TOC's 79 <xsl:param>toc.section.depth=4 80 # Max depth in each TOC: 81 <xsl:param>toc.max.depth=2 82 # How far down we go with TOC's 83 <xsl:param>generate.section.toc.level=10 84 # Horizontal ? spacing in table cells. 85 <format>html:<xsl:param>html.cellspacing=3 # pixels 86 # Vertical spacing in table cells. 87 <format>html:<xsl:param>html.cellpadding=5 # pixels 88 <format>html:<xsl:param>boost.max.id.part.length=40 89 <format>html:<xsl:param>img.src.path=../images/ 90 91 # PDF Options: 92 # ============ 93 # TOC Generation: this is needed for FOP-0.9 and later: 94 <format>pdf:<xsl:param>fop1.extensions=0 95 # Or enable this if you're using XEP: 96 <format>pdf:<xsl:param>xep.extensions=1 97 # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9! 98 <format>pdf:<xsl:param>fop.extensions=0 99 # No indent on body text: 100 <xsl:param>body.start.indent=0pt 101 # Margin size: 102 <xsl:param>page.margin.inner=0.5in 103 # Margin size: 104 <xsl:param>page.margin.outer=0.5in 105 106 # Yes, we want graphics for admonishments: 107 <xsl:param>admon.graphics=1 108 109 # Set these one for PDF generation *only*: 110 # default png graphics are awful in PDF form, 111 # better use SVG instead: 112 <format>pdf:<xsl:param>admon.graphics.extension=".svg" 113 #<format>pdf:<xsl:param>admon.graphics.extension=".png" # Only png images are available. 114 <format>pdf:<xsl:param>use.role.for.mediaobject=1 115 <format>pdf:<xsl:param>preferred.mediaobject.role=print 116 <format>pdf:<xsl:param>img.src.path=$(images_location)/ # graphics (diagrams) for pdf. 117 <format>pdf:<xsl:param>draft.mode="no" 118 <format>pdf:<xsl:param>boost.url.prefix=I:/boost-sandbox/guild/pool/libs/pool/doc/html 119 120 # <auto-index>on turns on index (or off). 121 <auto-index>on 122 <auto-index-verbose>on 123 124 # Choose indexing method (separately for html and pdf): 125 <format>html:<auto-index-internal>on # on (or off) to use internally generated indexes. 126 # <format>html:<xsl:param>generate.index=0 # Don't let the XSL stylesheets generate indexes. 127 128 <format>pdf:<auto-index-internal>off # on (or off) to use internally generated indexes. 129 # <auto-index-type>index # Use <index>...</index> as the XML wrapper. 130 131 <format>pdf:<xsl:param>index.on.type=1 # For the native stylesheets to generate the different indexes. 132 # PDF native index support is probably better for PDFs as then you actually get page numbers. 133 134 <auto-index-script>index.idx # Specifies the name of the script to load. 135 # <auto-index-prefix>../../../ # Path to /pool so index.idx !scan-path can use boost/ and libs/doc. 136 <auto-index-prefix>../../.. 137 138 <dependency>autodoc # 139 ; 140 141install pdfinstall : standalone/<format>pdf : <location>. <install-type>PDF <name>pool.pdf ; 142explicit pdfinstall ; 143 144############################################################################### 145alias boostdoc ; 146explicit boostdoc ; 147alias boostrelease : standalone ; 148explicit boostrelease ; 149