mirror of
https://github.com/boostorg/geometry.git
synced 2026-02-11 11:52:11 +00:00
Boost.Geometry doc updates and fixes
[SVN r76997]
This commit is contained in:
@@ -228,7 +228,9 @@ struct disjoint_reversed
|
||||
\param geometry1 \param_geometry
|
||||
\param geometry2 \param_geometry
|
||||
\return \return_check2{are disjoint}
|
||||
*/
|
||||
|
||||
\qbk{[include reference/algorithms/disjoint.qbk]}
|
||||
*/
|
||||
template <typename Geometry1, typename Geometry2>
|
||||
inline bool disjoint(Geometry1 const& geometry1,
|
||||
Geometry2 const& geometry2)
|
||||
|
||||
@@ -216,14 +216,7 @@ struct envelope
|
||||
\param geometry \param_geometry
|
||||
\param mbr \param_box \param_set{envelope}
|
||||
|
||||
\par Example:
|
||||
Example showing envelope calculation, using point_ll latlong points
|
||||
\dontinclude doxygen_1.cpp
|
||||
\skip example_envelope_polygon
|
||||
\line {
|
||||
\until }
|
||||
|
||||
|
||||
\qbk{[include reference/algorithms/envelope.qbk]}
|
||||
\qbk{
|
||||
[heading Example]
|
||||
[envelope] [envelope_output]
|
||||
@@ -253,6 +246,7 @@ inline void envelope(Geometry const& geometry, Box& mbr)
|
||||
\param geometry \param_geometry
|
||||
\return \return_calc{envelope}
|
||||
|
||||
\qbk{[include reference/algorithms/envelope.qbk]}
|
||||
\qbk{
|
||||
[heading Example]
|
||||
[return_envelope] [return_envelope_output]
|
||||
|
||||
@@ -250,6 +250,7 @@ struct for_each_segment<polygon_tag, Polygon, Functor, IsConst>
|
||||
\tparam Functor \tparam_functor
|
||||
|
||||
\qbk{distinguish,const version}
|
||||
\qbk{[include reference/algorithms/for_each_point.qbk]}
|
||||
\qbk{[heading Example]}
|
||||
\qbk{[for_each_point_const] [for_each_point_const_output]}
|
||||
*/
|
||||
@@ -277,6 +278,7 @@ inline Functor for_each_point(Geometry const& geometry, Functor f)
|
||||
\tparam Geometry \tparam_geometry
|
||||
\tparam Functor \tparam_functor
|
||||
|
||||
\qbk{[include reference/algorithms/for_each_point.qbk]}
|
||||
\qbk{[heading Example]}
|
||||
\qbk{[for_each_point] [for_each_point_output]}
|
||||
*/
|
||||
@@ -305,6 +307,7 @@ inline Functor for_each_point(Geometry& geometry, Functor f)
|
||||
\tparam Functor \tparam_functor
|
||||
|
||||
\qbk{distinguish,const version}
|
||||
\qbk{[include reference/algorithms/for_each_segment.qbk]}
|
||||
\qbk{[heading Example]}
|
||||
\qbk{[for_each_segment_const] [for_each_segment_const_output]}
|
||||
*/
|
||||
@@ -331,6 +334,8 @@ inline Functor for_each_segment(Geometry const& geometry, Functor f)
|
||||
\param f \par_for_each_f{segment}
|
||||
\tparam Geometry \tparam_geometry
|
||||
\tparam Functor \tparam_functor
|
||||
|
||||
\qbk{[include reference/algorithms/for_each_segment.qbk]}
|
||||
*/
|
||||
template<typename Geometry, typename Functor>
|
||||
inline Functor for_each_segment(Geometry& geometry, Functor f)
|
||||
|
||||
@@ -35,6 +35,7 @@ namespace boost { namespace geometry
|
||||
\return \return_check{is self-intersecting}
|
||||
|
||||
\qbk{distinguish,one geometry}
|
||||
\qbk{[def __one_parameter__]}
|
||||
\qbk{[include reference/algorithms/intersects.qbk]}
|
||||
*/
|
||||
template <typename Geometry>
|
||||
|
||||
@@ -179,7 +179,9 @@ struct overlaps<box_tag, box_tag, Box1, Box2>
|
||||
\brief \brief_check2{overlap}
|
||||
\ingroup overlaps
|
||||
\return \return_check2{overlap}
|
||||
*/
|
||||
|
||||
\qbk{[include reference/algorithms/overlaps.qbk]}
|
||||
*/
|
||||
template <typename Geometry1, typename Geometry2>
|
||||
inline bool overlaps(Geometry1 const& geometry1, Geometry2 const& geometry2)
|
||||
{
|
||||
|
||||
@@ -36,6 +36,9 @@ namespace model { namespace d2
|
||||
[heading Model of]
|
||||
[link geometry.reference.concepts.concept_point Point Concept]
|
||||
}
|
||||
|
||||
\qbk{[include reference/geometries/point_assign_warning.qbk]}
|
||||
|
||||
*/
|
||||
template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
|
||||
class point_xy : public model::point<CoordinateType, 2, CoordinateSystem>
|
||||
|
||||
Reference in New Issue
Block a user