geometry/doc/generated/segment_range.qbk
Barend Gehrels 9382f261fb Doc update, moved reference/* to generated/* and ref/* to reference/*
doxygen_xml2qbk escaping of underscores

[SVN r69328]
2011-02-27 14:02:14 +00:00

69 lines
1.4 KiB
Plaintext

[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
Use, modification and distribution is subject to the Boost Software License,
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1segment__range.xml]
[section:segment_range segment_range]
Range, walking over the two points of a segment.
[heading Synopsis]
``template<typename Segment>
class segment_range
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Segment] [segment type ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``segment_range(Segment const & segment)``
] [] [[* Segment const &]: ['segment]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
[[``const_iterator begin``
] [] [
]]
[[``const_iterator end``
] [] [
]]
]
[heading Header]
`#include <boost/geometry/ranges/segment_range.hpp>`
[endsect]