summaryrefslogtreecommitdiffstats
path: root/src/boost/tools/docca/example/Jamfile
blob: 4a68cc56b4ca816eb58a7a38c4b242a1d94e9e77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
#
# Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
# Copyright (c) 2021 Dmitry Arkhipov (grisumbras@gmail.com)
#
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#
# Official repository: https://github.com/cppalliance/json
#

project json/doc ;

import boostbook ;
import ../../../tools/docca/docca.jam ;


# Produce the reference.qbk from C++ sources
docca.reference reference.qbk
    : xsl/custom-overrides.xsl
      [ glob-tree-ex include/docca : *.hpp ]
    : <doxygen:param>PROJECT_NAME=docca
      <doxygen:param>PROJECT_NUMBER=
      <doxygen:param>PROJECT_BRIEF="Documentation Library"
      <doxygen:param>ABBREVIATE_BRIEF=
      <doxygen:param>ALWAYS_DETAILED_SEC=YES
      <doxygen:param>INLINE_INHERITED_MEMB=YES
      <doxygen:param>FULL_PATH_NAMES=NO
      <doxygen:param>JAVADOC_AUTOBRIEF=YES
      <doxygen:param>MULTILINE_CPP_IS_BRIEF=YES
      <doxygen:param>DISTRIBUTE_GROUP_DOC=YES
      <doxygen:param>EXTRACT_ALL=YES
      <doxygen:param>EXTRACT_PRIVATE=YES
      <doxygen:param>EXTRACT_STATIC=YES
      <doxygen:param>EXTRACT_LOCAL_CLASSES=NO
      <doxygen:param>SHOW_INCLUDE_FILES=NO
      <doxygen:param>INLINE_INFO=NO
      <doxygen:param>SORT_MEMBER_DOCS=NO
      <doxygen:param>SORT_MEMBERS_CTORS_1ST=YES
      <doxygen:param>GENERATE_TODOLIST=NO
      <doxygen:param>GENERATE_TESTLIST=NO
      <doxygen:param>GENERATE_BUGLIST=NO
      <doxygen:param>GENERATE_DEPRECATEDLIST=NO
      <doxygen:param>SHOW_USED_FILES=NO
      <doxygen:param>SHOW_FILES=NO
      <doxygen:param>SHOW_NAMESPACES=NO
      <doxygen:param>FILE_PATTERNS=
      <doxygen:param>EXAMPLE_PATTERNS=
      <doxygen:param>MACRO_EXPANSION=YES
      <doxygen:param>EXPAND_ONLY_PREDEF=YES
      <doxygen:param>PREDEFINED="\\
        DOXYGEN \\
        GENERATING_DOCS \\
        _MSC_VER"
      <doxygen:param>CLASS_DIAGRAMS=NO
      #<doxygen:param>STRIP_FROM_PATH=$(EXAMPLE_DIR)/include/docca
      #<doxygen:param>STRIP_FROM_INC_PATH=$(EXAMPLE_DIR)/include/docca
    ;

#-------------------------------------------------------------------------------
#
# Produce the reference.qbk file by running
# the reference xml through the transform.
#
#make reference.qbk
#    :
#        reference.xml
#        transform.xsl
#    :
#        saxonhe.saxonhe
#    ;

#-------------------------------------------------------------------------------
#
# Produce the Boost.Book XML from the QuickBook
#

install images
    :
        [ glob images/*.png ]
    :
        <location>html/json/images
    ;

explicit images ;

xml json_doc
    :
        main.qbk
    :
        <use>reference.qbk
        <dependency>images
    ;

explicit json_doc ;

#-------------------------------------------------------------------------------
#
# HTML documentation for $(BOOST_ROOT)/doc/html
#
#-------------------------------------------------------------------------------

boostbook json
    :
        json_doc
    :
        <xsl:param>boost.root=../../../..
        <xsl:param>chapter.autolabel=1
        <xsl:param>chunk.section.depth=8                # Depth to which sections should be chunked
        <xsl:param>chunk.first.sections=1               # Chunk the first top-level section?
        <xsl:param>toc.section.depth=2                  # How deep should recursive sections appear in the TOC?
        <xsl:param>toc.max.depth=8                      # How many levels should be created for each TOC?
        <xsl:param>generate.section.toc.level=8         # Control depth of TOC generation in sections
        <xsl:param>generate.toc="chapter toc,title section nop reference nop"
        <include>../../../tools/boostbook/dtd
    :
        <dependency>images
    ;

#-------------------------------------------------------------------------------
#
# These are used to inform the build system of the
# means to build the integrated and stand-alone docs.
#

alias boostdoc ;
explicit boostdoc ;

alias boostrelease : json ;
explicit boostrelease ;