mirror of
https://github.com/boostorg/geometry.git
synced 2026-02-17 13:52:09 +00:00
8102c48d65
Conflicts: doc/doxy/doxygen_output/html/doxygen.css doc/doxy/doxygen_output/html/doxygen.png doc/doxy/doxygen_output/html/tabs.css doc/html/index.html doc/index/rtree/query.qbk doc/make_qbk.py doc/quickbook/quickref.xml doc/quickref.xml doc/release_notes.qbk doc/src/docutils/tools/doxygen_xml2qbk/configuration.hpp doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp example/07_b_graph_route_example.cpp example/c11_custom_cs_transform_example.cpp example/ml02_distance_strategy.cpp extensions/example/gis/io/shapelib/shapelib.cpp extensions/example/gis/latlong/distance_example.cpp extensions/example/gis/latlong/point_ll_example.cpp extensions/example/gis/projections/p03_projmap_example.cpp extensions/example/gis/projections/p04_example.cpp extensions/example/gis/projections/p05_example.cpp extensions/test/algorithms/Jamfile.v2 extensions/test/algorithms/dissolve.cpp extensions/test/algorithms/offset.cpp extensions/test/gis/latlong/andoyer.cpp extensions/test/gis/latlong/cross_track.cpp extensions/test/gis/latlong/distance_mixed.cpp extensions/test/gis/latlong/vincenty.cpp extensions/test/gis/projections/projections.cpp extensions/test/nsphere/Jamfile.v2 extensions/test/nsphere/nsphere-access.cpp extensions/test/nsphere/nsphere-area.cpp extensions/test/nsphere/nsphere-circle.cpp extensions/test/nsphere/nsphere-disjoint.cpp extensions/test/nsphere/nsphere-index_content.cpp extensions/test/nsphere/nsphere-index_margin.cpp extensions/test/nsphere/nsphere-multi_within.cpp extensions/test/nsphere/nsphere-nsphere_in_box.cpp extensions/test/nsphere/nsphere-point_in_nsphere.cpp extensions/test/nsphere/nsphere-point_type.cpp extensions/test/nsphere/nsphere-within.cpp include/boost/geometry/algorithms/detail/buffer/buffer_inserter.hpp include/boost/geometry/algorithms/detail/buffer/buffer_policies.hpp include/boost/geometry/algorithms/detail/buffer/buffered_ring.hpp include/boost/geometry/algorithms/detail/buffer/line_line_intersection.hpp include/boost/geometry/algorithms/detail/disjoint.hpp include/boost/geometry/algorithms/detail/multi_modify.hpp include/boost/geometry/algorithms/detail/overlay/append_no_dups_or_spikes.hpp include/boost/geometry/algorithms/detail/overlay/copy_segments.hpp include/boost/geometry/algorithms/detail/overlay/enrichment_info.hpp include/boost/geometry/algorithms/detail/overlay/get_turns.hpp include/boost/geometry/algorithms/detail/overlay/self_turn_points.hpp include/boost/geometry/algorithms/detail/overlay/traverse.hpp include/boost/geometry/algorithms/detail/point_is_spike_or_equal.hpp include/boost/geometry/algorithms/detail/sections/sectionalize.hpp include/boost/geometry/algorithms/disjoint.hpp include/boost/geometry/algorithms/distance.hpp include/boost/geometry/algorithms/num_points.hpp include/boost/geometry/algorithms/simplify.hpp include/boost/geometry/extensions/algebra/algebra.hpp include/boost/geometry/extensions/algebra/algorithms/convert.hpp include/boost/geometry/extensions/algebra/algorithms/detail.hpp include/boost/geometry/extensions/algebra/algorithms/rotation.hpp include/boost/geometry/extensions/algorithms/connect.hpp include/boost/geometry/extensions/algorithms/detail/overlay/dissolver.hpp include/boost/geometry/extensions/algorithms/dissolve.hpp include/boost/geometry/extensions/algorithms/offset.hpp include/boost/geometry/extensions/algorithms/remove_holes_if.hpp include/boost/geometry/extensions/algorithms/remove_marked.hpp include/boost/geometry/extensions/algorithms/selected.hpp include/boost/geometry/extensions/contrib/ttmath_stub.hpp include/boost/geometry/extensions/gis/geographic/strategies/andoyer.hpp include/boost/geometry/extensions/gis/geographic/strategies/distance_cross_track.hpp include/boost/geometry/extensions/gis/geographic/strategies/vincenty.hpp include/boost/geometry/extensions/gis/io/shapelib/shp_create_object_multi.hpp include/boost/geometry/extensions/gis/projections/impl/pj_fwd.hpp include/boost/geometry/extensions/gis/projections/new_projection.hpp include/boost/geometry/extensions/gis/projections/projection_point_type.hpp include/boost/geometry/extensions/multi/algorithms/dissolve.hpp include/boost/geometry/extensions/nsphere/algorithms/disjoint.hpp include/boost/geometry/extensions/nsphere/algorithms/within.hpp include/boost/geometry/extensions/nsphere/core/radius.hpp include/boost/geometry/extensions/nsphere/core/tags.hpp include/boost/geometry/extensions/nsphere/index/detail/algorithms/bounds.hpp include/boost/geometry/extensions/nsphere/index/detail/algorithms/comparable_distance_near.hpp include/boost/geometry/extensions/nsphere/index/detail/algorithms/content.hpp include/boost/geometry/extensions/nsphere/index/detail/rtree/linear/redistribute_elements.hpp include/boost/geometry/extensions/nsphere/nsphere.hpp include/boost/geometry/extensions/nsphere/strategies/cartesian/nsphere_in_box.hpp include/boost/geometry/extensions/nsphere/strategies/cartesian/point_in_nsphere.hpp include/boost/geometry/extensions/nsphere/views/center_view.hpp include/boost/geometry/index/detail/rtree/utilities/gl_draw.hpp include/boost/geometry/index/rtree.hpp include/boost/geometry/multi/algorithms/distance.hpp include/boost/geometry/multi/geometries/concepts/multi_linestring_concept.hpp include/boost/geometry/multi/geometries/concepts/multi_point_concept.hpp include/boost/geometry/multi/geometries/concepts/multi_polygon_concept.hpp include/boost/geometry/multi/io/wkt/read.hpp include/boost/geometry/strategies/agnostic/buffer_distance_asymmetric.hpp include/boost/geometry/strategies/agnostic/buffer_distance_symmetric.hpp include/boost/geometry/strategies/agnostic/buffer_end_skip.hpp include/boost/geometry/strategies/buffer.hpp include/boost/geometry/strategies/cartesian/buffer_end_flat.hpp include/boost/geometry/strategies/cartesian/buffer_end_round.hpp include/boost/geometry/strategies/cartesian/buffer_join_miter.hpp include/boost/geometry/strategies/cartesian/buffer_join_round.hpp include/boost/geometry/strategies/cartesian/buffer_join_round_by_divide.hpp include/boost/geometry/strategies/cartesian/distance_projected_point.hpp include/boost/geometry/strategies/cartesian/distance_pythagoras.hpp include/boost/geometry/strategies/concepts/distance_concept.hpp include/boost/geometry/strategies/default_distance_result.hpp include/boost/geometry/strategies/spherical/distance_cross_track.hpp include/boost/geometry/strategies/spherical/distance_haversine.hpp include/boost/geometry/util/math.hpp index/example/benchmark_experimental.cpp index/example/glut_vis.cpp index/example/serialize.cpp index/test/rtree/interprocess/Jamfile.v2 index/test/rtree/test_rtree.hpp test/algorithms/Jamfile.v2 test/algorithms/buffer/Jamfile.v2 test/algorithms/buffer/multi_linestring_buffer.cpp test/algorithms/buffer/multi_point_buffer.cpp test/algorithms/buffer/multi_polygon_buffer.cpp test/algorithms/buffer/point_buffer.cpp test/algorithms/buffer/polygon_buffer.cpp test/algorithms/difference.cpp test/algorithms/intersection.cpp test/algorithms/intersects.cpp test/algorithms/overlay/overlay_cases.hpp test/algorithms/overlay/robustness/Jamfile.v2 test/algorithms/test_intersection.hpp test/algorithms/test_simplify.hpp test/algorithms/test_union.hpp test/algorithms/union.cpp test/geometry_test_common.hpp test/multi/algorithms/Jamfile.v2 test/multi/algorithms/multi_difference_spike.cpp test/multi/algorithms/multi_distance.cpp
=========================================================================== 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/1_45_0/doc/html/quickbook/install.html#quickbook.install.linux 3) unpack RapidXML, see src/docutils/tools/doxygen_xml2qbk/contrib/readme.txt 4) compile doxygen_xml2qbk, in src/docutils/tools/doxygen_xml2qbk 5) put binary somewhere, e.g. in /usr/local/bin/doxygen_xml2qbk 6) 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) in file doc/doxy/doxygen_input/groups/groups.hpp, define the group "foo" 3) in file doc/make_qbk.py, include the algorithm "foo" 4) in file doc/reference.qbk, include the foo.qbk ([include generated/foo.qbk]) 5) in file doc/quickref.xml, include a section on foo conform other sections 6) in file doc/src/docutils/tools/support_status/support_status.cpp include the algorithm (3 places) (optionally) 7) in file doc/reference/foo.qbk (to be created), include the support status and write other text, and include examples (optionally) 8) in file doc/imports.qbk, include the example foo.cpp (if any) 9) create file doc/src/examples/algorithm/foo.cpp (optional)