Skip to content

Commit

Permalink
[fix] a few qbk includes were missing
Browse files Browse the repository at this point in the history
* also fixed frechet/haussdorff documentation
* removed ancient msvc support for doxygen_xml2qbk
* fixes #1309
  • Loading branch information
barendgehrels committed Oct 2, 2024
1 parent 310498b commit d41c7e9
Show file tree
Hide file tree
Showing 25 changed files with 115 additions and 555 deletions.
1 change: 1 addition & 0 deletions doc/doxy/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ ALIASES = qbk{1}="\xmlonly <qbk>\1</qbk> \endxmlonly" \
details_calc{1}="The free function \1 calculates the \1 of a geometry" \
details_calc2{2}="The free function \1 calculates the \2 of two geometries" \
details_calc2{1}="The free function \1 calculates the \1 of two geometries" \
details_free_function{3}="The free function [^\1] calculates the \2 \3 two geometries" \
details_check12{2}="The free function \1 checks if the first geometry \2 the second geometry" \
details_macro{2}="The macro \1 registers a \2 such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type." \
details_macro_const="The const version registers only read access to the fields, the point type is therefore read-only." \
Expand Down
13 changes: 11 additions & 2 deletions doc/reference/algorithms/discrete_frechet_distance.qbk
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,17 @@

[def __this_function__ discrete_frechet_distance]

[heading Behavior]
The algorithm calculate discrete frechet distance between two geometries.
[heading_conformance_no_ogc [^__this_function__]]
[note PostGIS contains an algorithm ST_FrechetDistance with similar functionality.
See the [@https://postgis.net/docs/ST_FrechetDistance.html PostGIS documentation].
]

[heading Supported geometries]

[table
[[Geometries][Status]]
[[Linestring-Linestring][ [$img/ok.png] ]]
]

[note The units of the distance depends on strategy. In order to change the
default behavior a user has to create a strategy and pass it explicitly into
Expand Down
16 changes: 14 additions & 2 deletions doc/reference/algorithms/discrete_hausdorff_distance.qbk
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,20 @@

[def __this_function__ discrete_hausdorff_distance]

[heading Behavior]
The algorithm calculate discrete hausdorff distance between two geometries.
[heading_conformance_no_ogc [^__this_function__]]
[note PostGIS contains an algorithm ST_HausdorffDistance with similar functionality.
See the [@https://postgis.net/docs/ST_HausdorffDistance.html PostGIS documentation].
]

[heading Supported geometries]

[table
[[Geometries][Status]]
[[Linestring-Linestring][ [$img/ok.png] ]]
[[MultiPoint-MultiPoint][ [$img/ok.png] ]]
[[Point-MultiPoint][ [$img/ok.png] ]]
[[MultiLineString-MultiLinestring][ [$img/ok.png] ]]
]

[note The units of the distance depends on strategy. In order to change the
default behavior a user has to create a strategy and pass it explicitly into
Expand Down
20 changes: 0 additions & 20 deletions doc/src/docutils/tools/doxygen_xml2qbk/boost.vsprops

This file was deleted.

2 changes: 1 addition & 1 deletion doc/src/docutils/tools/doxygen_xml2qbk/configuration.hpp
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Boost.Geometry (aka GGL, Generic Geometry Library)
// Doxygen XML to Quickbook Converter
//
// Copyright (c) 2010-2013 Barend Gehrels, Amsterdam, the Netherlands.
// Copyright (c) 2012-2013 Adam Wulkiewicz, Lodz, Poland.
Expand Down
12 changes: 0 additions & 12 deletions doc/src/docutils/tools/doxygen_xml2qbk/deployment_path.vsprops

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Boost.Geometry (aka GGL, Generic Geometry Library)
// Doxygen XML to Quickbook Converter
//
// Copyright (c) 2010-2013 Barend Gehrels, Amsterdam, the Netherlands.
// Copyright (c) 2012-2013 Adam Wulkiewicz, Lodz, Poland.
Expand Down
5 changes: 2 additions & 3 deletions doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// doxml2qbk (developed in the context of Boost.Geometry documentation)
// Doxygen XML to Quickbook Converter
//
// Copyright (c) 2010-2013 Barend Gehrels, Amsterdam, the Netherlands.
// Copyright (c) 2010-2024 Barend Gehrels, Amsterdam, the Netherlands.
// Copyright (c) 2012-2013 Adam Wulkiewicz, Lodz, Poland.
//
// This file was modified by Oracle on 2020.
Expand All @@ -22,7 +22,6 @@
// using /xmlonly
// currently this is the element <qbk.example> which will make a reference
// to an example.
// - currently still in draft

#include <iostream>
#include <fstream>
Expand Down
20 changes: 0 additions & 20 deletions doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.sln

This file was deleted.

226 changes: 0 additions & 226 deletions doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.vcproj

This file was deleted.

Loading

0 comments on commit d41c7e9

Please sign in to comment.