Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / beast / doc / docca / README.md
1 # docca
2
3 Docca is a set of XSLT transformations which converts Doxygen
4 XML extracted from Javadoc comments in C++ source code, into
5 Boost.Quickbook output
6
7 These scripts are used by
8 [Boost.Beast](https://github.com/boostorg/beast/)
9 to generate the reference.
10 For example, this
11 [Javadoc comment](https://github.com/boostorg/beast/blob/b7230f12f16fe7a9f7a1ece5be1f607c8552448a/include/boost/beast/core/buffers_cat.hpp#L68])
12 is extracted by Doxygen into an intermediate XML representation,
13 then processed by the XSLT script via Saxon-HE to produce this
14 [Boost.Quickbook page](https://www.boost.org/doc/libs/1_71_0/libs/beast/doc/html/beast/ref/boost__beast__buffers_cat.html).
15
16 ## License
17
18 Distributed under the Boost Software License, Version 1.0.
19 (See accompanying file [LICENSE_1_0.txt](LICENSE_1_0.txt) or copy at
20 https://www.boost.org/LICENSE_1_0.txt)