interior_rings.qbk 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  5. Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
  6. Use, modification and distribution is subject to the Boost Software License,
  7. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  8. http://www.boost.org/LICENSE_1_0.txt)
  9. =============================================================================/]
  10. [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  11. [/ Generated from doxy/doxygen_output/xml/group__interior__rings.xml]
  12. [section:interior_rings_1 interior_rings]
  13. '''<indexterm><primary>interior_rings</primary></indexterm>'''
  14. Function to get the interior rings of a polygon (non const version)
  15. [heading Synopsis]
  16. ``template<typename Polygon>
  17. interior_return_type<Polygon>::type interior_rings(Polygon & polygon)``
  18. [heading Parameters]
  19. [table
  20. [[Type] [Concept] [Name] [Description] ]
  21. [[Polygon &] [polygon type ] [polygon] [the polygon to get the interior rings from ]]
  22. ]
  23. [heading Returns]
  24. the interior rings (possibly a reference)
  25. [heading Header]
  26. Either
  27. `#include <boost/geometry.hpp>`
  28. Or
  29. `#include <boost/geometry/core/interior_rings.hpp>`
  30. [endsect]
  31. [section:interior_rings_1_const_version interior_rings (const version)]
  32. '''<indexterm><primary>interior_rings</primary></indexterm>'''
  33. Function to get the interior rings of a polygon (const version)
  34. [heading Synopsis]
  35. ``template<typename Polygon>
  36. interior_return_type<Polygon const>::type interior_rings(Polygon const & polygon)``
  37. [heading Parameters]
  38. [table
  39. [[Type] [Concept] [Name] [Description] ]
  40. [[Polygon const &] [polygon type ] [polygon] [the polygon to get the interior rings from ]]
  41. ]
  42. [heading Returns]
  43. the interior rings (possibly a const reference)
  44. [heading Header]
  45. Either
  46. `#include <boost/geometry.hpp>`
  47. Or
  48. `#include <boost/geometry/core/interior_rings.hpp>`
  49. [endsect]