1=========================================================================== 2 Copyright (c) 2007-2011 Barend Gehrels, Amsterdam, the Netherlands. 3 Copyright (c) 2008-2011 Bruno Lalande, Paris, France. 4 Copyright (c) 2009-2011 Mateusz Loskot, London, UK 5 6 Use, modification and distribution is subject to the Boost Software License, 7 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 8 http://www.boost.org/LICENSE_1_0.txt) 9============================================================================ 10 11Procedure to create documentation using Doxygen, QuickBook and doxygen_xml2qbk 12 13Note that doxygen_xml2qbk is a tool currently (slightly) specific to Boost.Geometry, 14and that it translates from Doxygen-XML output to Quickbook (without xslt) 15 161) install Doxygen 172) install QuickBook using http://www.boost.org/doc/libs/release/doc/html/quickbook/install.html 183) run b2 in src/docutils/tools/doxygen_xml2qbk to build doxygen_xml2qbk executable 194) put binary in your PATH, e.g. in /usr/local/bin/doxygen_xml2qbk 205) execute python file "make_qbk.py" (calling doxygen, doxygen_xml2qbk, bjam) 21 22Folders in this folder: 23concept: manually written documentation QBK files, on concept 24doxy: folders and files needed for doxygen input and output 25html: contains generated HTML files 26other: older documentation (subject to update or deletion) 27ref: manually written documentation QBK files, included from .hpp files 28reference: generated documentation QBK files (by doxygen_xml2qbk) 29 [note: this book cannot be called "generated" or something like that, 30 because it is used in the final URL and we want to have "reference" in it] 31src: examples used in documentation and tools (doxygen_xml2qbk) 32 33Per new algorithm (e.g. foo), one should add: 341) in file boost/geometry/algorithms/foo.hpp, include a "\ingroup foo" in the doxygen comments 352) in file doc/doxy/doxygen_input/groups/groups.hpp, define the group "foo" 363) in file doc/make_qbk.py, include the algorithm "foo" 374) in file doc/reference.qbk, include the foo.qbk ([include generated/foo.qbk]) 385) in file doc/quickref.xml, include a section on foo conform other sections 396) in file doc/src/docutils/tools/support_status/support_status.cpp include the algorithm (3 places) (optionally) 407) in file doc/reference/foo.qbk (to be created), include the support status and write other text, and include examples (optionally) 418) in file doc/imports.qbk, include the example foo.cpp (if any) 429) create file doc/src/examples/algorithm/foo.cpp (optional) 43 44 45