Subject: [Boost-docs] Translating Doxygen defgroup to Quickbook
From: Mateusz Loskot (mateusz_at_[hidden])
Date: 2010-02-28 16:51:13
Doxygen supports @defgroup command  that can be used to make
a group of related elements. While combining Doxygen-generated XML
with Quickbook, I've noticed that this information is dropped - no
pages or sections are generated for defgroup.
I found that the libraries seem to handle the defgroup thing on their
own, in a custom way. It suggests there is no support for it in
Quickbook. So, I investigated Boost Asio docs in details as it looks
to me as best example of such solution.
What Boost.Asio does is
- generate the Doxygen-encoded docs to XML output
- transform the XML to Quickbook file reference.qbk 
using the xsltproc tool and custom stylesheet reference.xsl 
The whole process is fired with a simple script 
For example, header /boost/asio/read.hpp defines "async_read" group 
that gathers all overloads of the async_read function.
The documentation generator explained above puts all async_read versions
under common node  in HTML output from Quickbook.
The Boost Asio manner of handling with the defgroup thing
sounds very well.
However, before I'll adopt it for Boost Geometry, I'd like to know if
there is any better or let's say recommended way to achieve this.
Perhaps Quickbook has got native support of Doxygen defgroup, etc.
I'd be thankful for comments.
-- Mateusz Loskot, http://mateusz.loskot.net Charter Member of OSGeo, http://osgeo.org
This archive was generated by hypermail 2.1.7 : 2017-11-11 08:50:41 UTC