From ac17fdcbdc8862f079c3a451467b5fdfd2ef1c2e Mon Sep 17 00:00:00 2001
From: Menelaos Karavelas <menelaos.karavelas@gmail.com>
Date: Fri, 27 Jun 2014 02:37:13 +0300
Subject: [PATCH] [algorithms][is_simple,is_valid] add doxygen documentation
 for is_simple and is_valid

---
 .../algorithms/detail/is_simple/interface.hpp       | 13 +++++++++++--
 .../algorithms/detail/is_valid/interface.hpp        | 12 ++++++++++--
 2 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/include/boost/geometry/algorithms/detail/is_simple/interface.hpp b/include/boost/geometry/algorithms/detail/is_simple/interface.hpp
index 739b8ead5..4239664ed 100644
--- a/include/boost/geometry/algorithms/detail/is_simple/interface.hpp
+++ b/include/boost/geometry/algorithms/detail/is_simple/interface.hpp
@@ -58,10 +58,19 @@ struct is_simple<boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)> >
 
 
 
+/*!
+\brief \brief_check{is simple}
+\ingroup is_simple
+\tparam Geometry \tparam_geometry
+\param geometry \param_geometry
+\return \return_check{is simple}
+
+\qbk{[include reference/algorithms/is_simple.qbk]}
+*/
 template <typename Geometry>
-inline bool is_simple(Geometry const& g)
+inline bool is_simple(Geometry const& geometry)
 {
-    return resolve_variant::is_simple<Geometry>::apply(g);
+    return resolve_variant::is_simple<Geometry>::apply(geometry);
 }
 
 
diff --git a/include/boost/geometry/algorithms/detail/is_valid/interface.hpp b/include/boost/geometry/algorithms/detail/is_valid/interface.hpp
index 93d7359ac..4b232fd43 100644
--- a/include/boost/geometry/algorithms/detail/is_valid/interface.hpp
+++ b/include/boost/geometry/algorithms/detail/is_valid/interface.hpp
@@ -57,11 +57,19 @@ struct is_valid<boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)> >
 } // namespace resolve_variant
 
 
+/*!
+\brief \brief_check{is valid (in the OGC sense)}
+\ingroup is_valid
+\tparam Geometry \tparam_geometry
+\param geometry \param_geometry
+\return \return_check{is valid (in the OGC sense)}
 
+\qbk{[include reference/algorithms/is_valid.qbk]}
+*/
 template <typename Geometry>
-inline bool is_valid(Geometry const& g)
+inline bool is_valid(Geometry const& geometry)
 {
-    return resolve_variant::is_valid<Geometry>::apply(g);
+    return resolve_variant::is_valid<Geometry>::apply(geometry);
 }