https://github.com/boostorg/docca

Boost.Book XSLT C++ documentation system
https://github.com/boostorg/docca

boost cplusplus docs docs-generator documentation html quickstart xslt

Last synced: 3 days ago
JSON representation

Boost.Book XSLT C++ documentation system

• Host: GitHub
• URL: https://github.com/boostorg/docca
• Owner: boostorg
• License: bsl-1.0
• Created: 2016-09-09T15:36:07.000Z (about 8 years ago)
• Default Branch: develop
• Last Pushed: 2024-11-01T08:55:44.000Z (15 days ago)
• Last Synced: 2024-11-01T09:30:25.875Z (15 days ago)
• Topics: boost, cplusplus, docs, docs-generator, documentation, html, quickstart, xslt
• Language: Python
• Size: 224 KB
• Stars: 17
• Watchers: 6
• Forks: 22
• Open Issues: 57
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE_1_0.txt

Awesome Lists containing this project

README

        
# docca

Docca is a set of XSLT transformations which converts Doxygen

XML extracted from Javadoc comments in C++ source code, into

Boost.Quickbook output

These scripts are used by

[Boost.Beast](https://github.com/boostorg/beast/)

to generate the reference.

For example, this

[Javadoc comment](https://github.com/boostorg/beast/blob/b7230f12f16fe7a9f7a1ece5be1f607c8552448a/include/boost/beast/core/buffers_cat.hpp#L68])

is extracted by Doxygen into an intermediate XML representation,

then processed by the XSLT script via Saxon-HE to produce this

[Boost.Quickbook page](https://www.boost.org/doc/libs/1_71_0/libs/beast/doc/html/beast/ref/boost__beast__buffers_cat.html).

## Usage

The following Doxygen configuration settings must be set as indicated:

    DISTRIBUTE_GROUP_DOC = YES

## License

Distributed under the Boost Software License, Version 1.0.

(See accompanying file [LICENSE_1_0.txt](LICENSE_1_0.txt) or copy at

https://www.boost.org/LICENSE_1_0.txt)