From c8475204e6eb7a0618745abcf762b2a5ca9766ff Mon Sep 17 00:00:00 2001 From: Barend Gehrels Date: Tue, 2 Apr 2013 17:53:51 +0000 Subject: [PATCH] [geometry] Fixes for Doxygen: we go back to ifdef DOXYGEN... for parameters which should not be documented, instead of qbk_skip. This because the newer versions of Doxygen did not support the qbk_skip construction anymore. Also removed from the comment because it complained about the end (there was a /2, meaning divide by two in between) [SVN r83714] --- include/boost/geometry/core/access.hpp | 13 +++++++++---- .../strategies/spherical/distance_haversine.hpp | 8 ++++---- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/include/boost/geometry/core/access.hpp b/include/boost/geometry/core/access.hpp index cdc8ff9cf..7cf93b9c1 100644 --- a/include/boost/geometry/core/access.hpp +++ b/include/boost/geometry/core/access.hpp @@ -260,13 +260,15 @@ struct signature_getset_index_dimension {}; \tparam Dimension \tparam_dimension_required \tparam Geometry \tparam_geometry (usually a Point Concept) \param geometry \param_geometry (usually a point) -\param dummy \qbk_skip \return The coordinate value of specified dimension of specified geometry + \qbk{[include reference/core/get_point.qbk]} */ template inline typename coordinate_type::type get(Geometry const& geometry +#ifndef DOXYGEN_SHOULD_SKIP_THIS , detail::signature_getset_dimension* dummy = 0 +#endif ) { boost::ignore_unused_variable_warning(dummy); @@ -292,7 +294,6 @@ inline typename coordinate_type::type get(Geometry const& geometry \param geometry geometry to assign coordinate to \param geometry \param_geometry (usually a point) \param value The coordinate value to set -\param dummy \qbk_skip \ingroup set \qbk{[include reference/core/set_point.qbk]} @@ -300,7 +301,9 @@ inline typename coordinate_type::type get(Geometry const& geometry template inline void set(Geometry& geometry , typename coordinate_type::type const& value +#ifndef DOXYGEN_SHOULD_SKIP_THIS , detail::signature_getset_dimension* dummy = 0 +#endif ) { boost::ignore_unused_variable_warning(dummy); @@ -325,7 +328,6 @@ inline void set(Geometry& geometry \tparam Dimension \tparam_dimension_required \tparam Geometry \tparam_box_or_segment \param geometry \param_geometry -\param dummy \qbk_skip \return coordinate value \ingroup get @@ -334,7 +336,9 @@ inline void set(Geometry& geometry */ template inline typename coordinate_type::type get(Geometry const& geometry +#ifndef DOXYGEN_SHOULD_SKIP_THIS , detail::signature_getset_index_dimension* dummy = 0 +#endif ) { boost::ignore_unused_variable_warning(dummy); @@ -361,7 +365,6 @@ inline typename coordinate_type::type get(Geometry const& geometry \param geometry geometry to assign coordinate to \param geometry \param_geometry \param value The coordinate value to set -\param dummy \qbk_skip \ingroup set \qbk{distinguish,with index} @@ -370,7 +373,9 @@ inline typename coordinate_type::type get(Geometry const& geometry template inline void set(Geometry& geometry , typename coordinate_type::type const& value +#ifndef DOXYGEN_SHOULD_SKIP_THIS , detail::signature_getset_index_dimension* dummy = 0 +#endif ) { boost::ignore_unused_variable_warning(dummy); diff --git a/include/boost/geometry/strategies/spherical/distance_haversine.hpp b/include/boost/geometry/strategies/spherical/distance_haversine.hpp index 59ec1c33f..5a866c2ed 100644 --- a/include/boost/geometry/strategies/spherical/distance_haversine.hpp +++ b/include/boost/geometry/strategies/spherical/distance_haversine.hpp @@ -100,14 +100,14 @@ on a perfect sphere using haversine \tparam CalculationType \tparam_calculation \author Adapted from: http://williams.best.vwh.net/avform.htm \see http://en.wikipedia.org/wiki/Great-circle_distance -\note It says: The great circle distance d between two +\note (from Wiki:) The great circle distance d between two points with coordinates {lat1,lon1} and {lat2,lon2} is given by: d=acos(sin(lat1)*sin(lat2)+cos(lat1)*cos(lat2)*cos(lon1-lon2)) A mathematically equivalent formula, which is less subject to rounding error for short distances is: - d=2*asin(sqrt((sin((lat1-lat2)/2))^2 - + cos(lat1)*cos(lat2)*(sin((lon1-lon2)/2))^2)) - + d=2*asin(sqrt((sin((lat1-lat2) / 2))^2 + + cos(lat1)*cos(lat2)*(sin((lon1-lon2) / 2))^2)) + \qbk{ [heading See also]