[Boost-commit] svn:boost r83714 - in trunk/boost/geometry: core strategies/spherical

Subject: [Boost-commit] svn:boost r83714 - in trunk/boost/geometry: core strategies/spherical
From: barend.gehrels_at_[hidden]
Date: 2013-04-02 13:53:52

Author: barendgehrels
Date: 2013-04-02 13:53:51 EDT (Tue, 02 Apr 2013)
New Revision: 83714
URL: http://svn.boost.org/trac/boost/changeset/83714

Log:
[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 <em> from the comment because it complained about the end (there was a /2, meaning divide by two in between)
Text files modified: 
   trunk/boost/geometry/core/access.hpp                             |    13 +++++++++----                           
   trunk/boost/geometry/strategies/spherical/distance_haversine.hpp |     8 ++++----                                
   2 files changed, 13 insertions(+), 8 deletions(-)

Modified: trunk/boost/geometry/core/access.hpp
==============================================================================
--- trunk/boost/geometry/core/access.hpp	(original)
+++ trunk/boost/geometry/core/access.hpp	2013-04-02 13:53:51 EDT (Tue, 02 Apr 2013)
@@ -260,13 +260,15 @@
 \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 <std::size_t Dimension, typename Geometry>
 inline typename coordinate_type<Geometry>::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 @@
 \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 @@
 template <std::size_t Dimension, typename Geometry>
 inline void set(Geometry& geometry
         , typename coordinate_type<Geometry>::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 @@
 \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 @@
 */
 template <std::size_t Index, std::size_t Dimension, typename Geometry>
 inline typename coordinate_type<Geometry>::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 @@
 \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 @@
 template <std::size_t Index, std::size_t Dimension, typename Geometry>
 inline void set(Geometry& geometry
         , typename coordinate_type<Geometry>::type const& value
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
         , detail::signature_getset_index_dimension* dummy = 0
+#endif
         )
 {
     boost::ignore_unused_variable_warning(dummy);

Modified: trunk/boost/geometry/strategies/spherical/distance_haversine.hpp
==============================================================================
--- trunk/boost/geometry/strategies/spherical/distance_haversine.hpp	(original)
+++ trunk/boost/geometry/strategies/spherical/distance_haversine.hpp	2013-04-02 13:53:51 EDT (Tue, 02 Apr 2013)
@@ -100,14 +100,14 @@
 \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: <em>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))
-    </em>
+    d=2*asin(sqrt((sin((lat1-lat2) / 2))^2
+    + cos(lat1)*cos(lat2)*(sin((lon1-lon2) / 2))^2))
+    
 
 \qbk{
 [heading See also]