boostorg/docca
1
0
Fork 0
mirror of https://github.com/boostorg/docca.git synced 2026-07-21 13:13:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add license and update README

Browse Source
This commit is contained in:
Vinnie Falco
2019-09-15 17:06:54 -07:00
parent 30d6675331
commit 77a24a56c6
2 changed files with 41 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
LICENSE_1_0.txt
+23
View File
@@ -0,0 +1,23 @@
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
README.md
+18 -2
View File
@@ -1,4 +1,20 @@
# docca
Boost.Book XSLT C++ documentation system
[Example Documentation](http://vinniefalco.github.io/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).
## 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)