geometry/doc
Vissarion Fisikopoulos b9737c5a4d Release notes for 1.84 2023-12-04 13:42:11 +02:00
..
concept [doc] Update polygon concept documentation. 2022-11-17 16:51:04 +02:00
doxy Restore previous version in Doxyfiles 2022-01-12 10:49:08 +02:00
generated Add documentation generated files to .gitignore 2020-03-05 22:51:06 +01:00
html [doc] Update copyright date in index.html and remove unused links 2022-12-01 13:05:55 +02:00
index Remove CXX11/14 related macros 2023-05-23 15:16:08 +03:00
other [doc][util][formulas][test] Add copyright information in updated files 2018-06-18 18:05:11 +05:00
quickbook Rename concepts in documentation samples 2016-07-27 16:31:13 +02:00
reference [doc] Explain output range of azimuth algorithm. 2022-11-21 21:41:17 +02:00
src Remove CXX11/14 related macros 2023-05-23 15:16:08 +03:00
Jamfile Rename Jamfile.v2 to Jamfile (#679) 2020-03-08 23:50:18 +01:00
acknowledgments.qbk Boost.Geometry processed patch https://svn.boost.org/trac/boost/ticket/6166 for missing transformation 2012-02-24 15:36:23 +00:00
compiling.qbk Remove detailed list of compilers and versions form the docs (#816) 2021-02-19 19:55:35 +01:00
copyright_note_policy.txt Added copyright note policy 2011-03-26 23:08:11 +00:00
design_rationale.qbk [doc] Document Axis Order convention 2017-10-11 20:23:47 +01:00
example_adapting_a_legacy_geometry_object_model.qbk [doc] Fix legacy types adaptation example. 2017-01-09 18:12:35 +01:00
geometry.qbk Remove documentation creation from documentation as duplicate to the wiki. 2022-11-10 18:10:23 +02:00
imports.qbk [closest_points] Add documentation and examples 2021-11-18 11:15:48 +02:00
introduction.qbk [doc] GitHub repository info added to the Introduction 2014-01-23 02:31:53 +01:00
make_qbk.py [closest_points] Add documentation and examples 2021-11-18 11:15:48 +02:00
matrix.qbk geometry docs: sections rearranged, titles unified. 2013-05-13 00:39:43 +00:00
quickref.xml [closest_points] Add documentation and examples 2021-11-18 11:15:48 +02:00
quickstart.qbk Boost.Geometry update copyright -> 2012 2012-01-09 21:56:08 +00:00
readme.txt [closest_points] Several fixes: indentation, formating, pass correct types, activate tests 2022-01-05 14:38:06 +02:00
reference.qbk [closest_points] Add documentation and examples 2021-11-18 11:15:48 +02:00
release_notes.qbk Release notes for 1.84 2023-12-04 13:42:11 +02:00
robustness.qbk [geometry] Add TODO item EGC 2013-10-26 00:33:40 +00:00

readme.txt

===========================================================================
 Copyright (c) 2007-2011 Barend Gehrels, Amsterdam, the Netherlands.
 Copyright (c) 2008-2011 Bruno Lalande, Paris, France.
 Copyright (c) 2009-2011 Mateusz Loskot, London, UK

 Use, modification and distribution is subject to the Boost Software License,
 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
 http://www.boost.org/LICENSE_1_0.txt)
============================================================================

Procedure to create documentation using Doxygen, QuickBook and doxygen_xml2qbk

Note that doxygen_xml2qbk is a tool currently (slightly) specific to Boost.Geometry,
and that it translates from Doxygen-XML output to Quickbook (without xslt)

1) install Doxygen
2) install QuickBook using http://www.boost.org/doc/libs/release/doc/html/quickbook/install.html
3) run b2 in src/docutils/tools/doxygen_xml2qbk to build doxygen_xml2qbk executable
4) put binary in your PATH, e.g. in /usr/local/bin/doxygen_xml2qbk
5) execute python file "make_qbk.py" (calling doxygen, doxygen_xml2qbk, bjam)

Folders in this folder:
concept: manually written documentation QBK files, on concept
doxy: folders and files needed for doxygen input and output
html: contains generated HTML files
other: older documentation (subject to update or deletion)
ref: manually written documentation QBK files, included from .hpp files
reference: generated documentation QBK files (by doxygen_xml2qbk)
	[note: this book cannot be called "generated" or something like that,
	because it is used in the final URL and we want to have "reference" in it]
src: examples used in documentation and tools (doxygen_xml2qbk)

Per new algorithm (e.g. foo), one should add:
1) in file boost/geometry/algorithms/foo.hpp, include a "\ingroup foo" in the doxygen comments 
2) if a directory is created e.g. boost/geometry/algorithms/detail/foo the path should be added in doc/doxy/Doxyfile
3) in file doc/doxy/doxygen_input/groups/groups.hpp, define the group "foo"
4) in file doc/make_qbk.py, include the algorithm "foo"
5) in file doc/reference.qbk, include the foo.qbk ([include generated/foo.qbk])
6) in file doc/quickref.xml, include a section on foo conform other sections
7) in file doc/src/docutils/tools/support_status/support_status.cpp include the algorithm (3 places) (optionally)
8) in file doc/reference/foo.qbk (to be created), include the support status and write other text, and include examples (optionally)
9) in file doc/imports.qbk, include the example foo.cpp (if any)
10) create file doc/src/examples/algorithm/foo.cpp (optional)