geometry/doc/generated/multi_polygon.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

53 lines
1.6 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_1model_1_1multi__polygon.xml]
[section:model_multi_polygon model::multi_polygon]
multi_polygon, a collection of polygons
[heading Description]
Multi-polygon can be used to group polygons belonging to each other, e.g. Hawaii
[heading Model of]
[link geometry.reference.concepts.concept_multi_polygon MultiPolygon Concept]
[heading Synopsis]
``template<typename Polygon, template< typename, typename > class Container, template< typename > class Allocator>
class model::multi_polygon
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Default] [Description]]
[[typename Polygon] [] []]
[[template< typename, typename > class Container] [std::vector] []]
[[template< typename > class Allocator] [std::allocator] []]
]
[heading Header]
Either
`#include <boost/geometry/multi/multi.hpp>`
Or
`#include <boost/geometry/multi/geometries/multi_polygon.hpp>`
[endsect]