• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright (c) 2014 Renato Tegon Forti, Antony Polukhin.
2# Copyright (c) 2015-2019 Antony Polukhin.
3#
4# Distributed under the Boost Software License, Version 1.0. (See accompanying
5# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6
7using quickbook ;
8using boostbook ;
9using doxygen ;
10using xsltproc ;
11
12import set ;
13import doxygen ;
14import xsltproc ;
15import notfile ;
16import path ;
17
18project dll/doc ;
19
20#
21# Common params for doxygen
22#
23
24local doxygen_params =
25    <doxygen:param>HIDE_UNDOC_MEMBERS=YES
26    <doxygen:param>HIDE_UNDOC_CLASSES=YES
27    <doxygen:param>HIDE_SCOPE_NAMES=YES
28    <doxygen:param>EXTRACT_ALL=NO
29    <doxygen:param>EXTRACT_PRIVATE=NO
30    <doxygen:param>BUILTIN_STL_SUPPORT=YES
31    <doxygen:param>ENABLE_PREPROCESSING=YES
32    <doxygen:param>MACRO_EXPANSION=YES
33    <doxygen:param>"ALIASES= \\
34        \"forcedlink{1}=\\xmlonly<link linkend='boost.dll.\\1'>boost::dll::\\1</link>\\endxmlonly\" \\
35        \"forcedlinkfs{1}=\\xmlonly<link linkend='boost.dll.fs.\\1'>boost::dll::fs::\\1</link>\\endxmlonly\" \\
36        \"forcedmacrolink{1}=\\xmlonly<link linkend='\\1'>\\1</link>\\endxmlonly\" "
37    <doxygen:param>"PREDEFINED= \\
38        \"BOOST_RV_REF(T)=T&&\" \\
39        \"BOOST_RV_REF(shared_library)=shared_library&&\" \\
40        \"BOOST_COPY_ASSIGN_REF(shared_library)=const shared_library&\" \\
41        \"BOOST_MOVABLE_BUT_NOT_COPYABLE(shared_library)= \\
42            shared_library(const shared_library&) = delete; \\
43            shared_library& operator=(const shared_library&) = delete; \" \\
44        \"BOOST_DLL_IMPORT_RESULT_TYPE=result_type\" \\
45        \"BOOST_DLL_MANGLED_IMPORT_RESULT_TYPE=result_type\" \\
46        \"BOOST_EXPLICIT_OPERATOR_BOOL()=explicit operator bool() const noexcept;\" \\
47        \"BOOST_DLL_DOXYGEN\" "
48    ;
49
50#
51# Ref Sessions Generation
52#
53doxygen autodoc_shared_library_core
54    :
55        [ glob
56            ../include/boost/dll/config.hpp
57            ../include/boost/dll/shared_library.hpp
58            ../include/boost/dll/shared_library_load_mode.hpp
59            ../include/boost/dll/library_info.hpp
60            ../include/boost/dll/runtime_symbol_info.hpp
61            ../include/boost/dll/alias.hpp
62
63            ../include/boost/dll/smart_library.hpp
64        ]
65    :
66        $(doxygen_params)
67        <xsl:param>"boost.doxygen.reftitle=Shared Library Reference"
68    ;
69
70doxygen autodoc_shared_library_refcountable
71    :
72        [ glob
73            ../include/boost/dll/import.hpp
74            ../include/boost/dll/import_class.hpp
75            ../include/boost/dll/import_mangled.hpp
76        ]
77    :
78        $(doxygen_params)
79        <xsl:param>"boost.doxygen.reftitle=Shared Library Refcountable Reference"
80    ;
81
82#
83# Docs Generation
84#
85boostbook dll-doc
86    :
87        dll.qbk
88    :
89        <dependency>autodoc_shared_library_core
90        <dependency>autodoc_shared_library_refcountable
91        <xsl:param>boost.root=http://www.boost.org/doc/libs/1_60_0
92        #<xsl:param>boost.root=../../../.
93        <xml:param>html.stylesheet=../../../../doc/src/boostbook.css
94    ;
95
96###############################################################################
97alias boostdoc
98    : dll-doc/<format>docbook
99    :
100    :
101    : ;
102explicit boostdoc ;
103alias boostrelease ;
104explicit boostrelease ;
105