mirror of
https://github.com/boostorg/geometry.git
synced 2026-02-02 08:52:10 +00:00
[algorithms][is_simple,is_valid] add doxygen documentation for is_simple and is_valid
This commit is contained in:
@@ -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);
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -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);
|
||||
}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user