libs/geometry/doc/doxy/doxygen_output/xml/register_2linestring_8hpp.xml

   1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
   3   <compounddef id="register_2linestring_8hpp" kind="file">
   4     <compoundname>linestring.hpp</compoundname>
   5     <includes refid="tag_8hpp" local="no">boost/geometry/core/tag.hpp</includes>
   6     <includes refid="core_2tags_8hpp" local="no">boost/geometry/core/tags.hpp</includes>
   7     <incdepgraph>
   8       <node id="55504">
   9         <label>boost/type_traits/remove_const.hpp</label>
  10       </node>
  11       <node id="55502">
  12         <label>boost/geometry/core/tags.hpp</label>
  13         <link refid="core_2tags_8hpp"/>
  14       </node>
  15       <node id="55506">
  16         <label>boost/type_traits/remove_reference.hpp</label>
  17       </node>
  18       <node id="55503">
  19         <label>boost/geometry/util/bare_type.hpp</label>
  20         <link refid="bare__type_8hpp"/>
  21         <childnode refid="55504" relation="include">
  22         </childnode>
  23         <childnode refid="55505" relation="include">
  24         </childnode>
  25         <childnode refid="55506" relation="include">
  26         </childnode>
  27       </node>
  28       <node id="55500">
  29         <label>/home/ubuntu/boost/boost/geometry/geometries/register/linestring.hpp</label>
  30         <link refid="register/linestring.hpp"/>
  31         <childnode refid="55501" relation="include">
  32         </childnode>
  33         <childnode refid="55502" relation="include">
  34         </childnode>
  35       </node>
  36       <node id="55501">
  37         <label>boost/geometry/core/tag.hpp</label>
  38         <link refid="tag_8hpp"/>
  39         <childnode refid="55502" relation="include">
  40         </childnode>
  41         <childnode refid="55503" relation="include">
  42         </childnode>
  43       </node>
  44       <node id="55505">
  45         <label>boost/type_traits/remove_pointer.hpp</label>
  46       </node>
  47     </incdepgraph>
  48       <sectiondef kind="define">
  49       <memberdef kind="define" id="group__register_1ga1d26e8196d719505669ecdb89e11bd2b" prot="public" static="no">
  50         <name>BOOST_GEOMETRY_REGISTER_LINESTRING</name>
  51         <param><defname>Linestring</defname></param>
  52         <initializer>namespace boost { namespace geometry { namespace traits {  \
  53     template&lt;&gt; struct tag&lt;Linestring&gt; { typedef linestring_tag type; }; \
  54 }}}</initializer>
  55         <briefdescription>
  56 <para>Macro to register a linestring. </para>        </briefdescription>
  57         <detaileddescription>
  58 <para>The macro BOOST_GEOMETRY_REGISTER_LINESTRING registers a linestring such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The linestring may contain template parameters, which must be specified then. <parameterlist kind="param"><parameteritem>
  59 <parameternamelist>
  60 <parametername>Linestring</parametername>
  61 </parameternamelist>
  62 <parameterdescription>
  63 <para>linestring type to be registered</para></parameterdescription>
  64 </parameteritem>
  65 </parameterlist>
  66  <qbk>
  67 [heading Example]
  68 [register_linestring]
  69 [register_linestring_output]
  70 </qbk>  </para>        </detaileddescription>
  71         <inbodydescription>
  72         </inbodydescription>
  73         <location file="/home/ubuntu/boost/boost/geometry/geometries/register/linestring.hpp" line="35" column="9" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/register/linestring.hpp" bodystart="35" bodyend="-1"/>
  74       </memberdef>
  75       <memberdef kind="define" id="group__register_1ga56729e5117bdd1ef2f5df70e113135d1" prot="public" static="no">
  76         <name>BOOST_GEOMETRY_REGISTER_LINESTRING_TEMPLATED</name>
  77         <param><defname>Linestring</defname></param>
  78         <initializer>namespace boost { namespace geometry { namespace traits {  \
  79     template&lt;typename P&gt; struct tag&lt; Linestring&lt;P&gt; &gt; { typedef linestring_tag type; }; \
  80 }}}</initializer>
  81         <briefdescription>
  82 <para>Macro to register a templated linestring. </para>        </briefdescription>
  83         <detaileddescription>
  84 <para>The macro BOOST_GEOMETRY_REGISTER_LINESTRING_TEMPLATED registers a templated linestring such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The type must have one template parameter, which should be a point type, and should not be specified. Boost.Geometry takes care of inserting the template parameter. Hence all types of this templated linestring are registered, regardless of their point type. <parameterlist kind="param"><parameteritem>
  85 <parameternamelist>
  86 <parametername>Linestring</parametername>
  87 </parameternamelist>
  88 <parameterdescription>
  89 <para>linestring (without template parameters) type to be registered</para></parameterdescription>
  90 </parameteritem>
  91 </parameterlist>
  92  <qbk>
  93 [heading Example]
  94 [register_linestring_templated]
  95 [register_linestring_templated_output]
  96 </qbk>  </para>        </detaileddescription>
  97         <inbodydescription>
  98         </inbodydescription>
  99         <location file="/home/ubuntu/boost/boost/geometry/geometries/register/linestring.hpp" line="54" column="9" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/register/linestring.hpp" bodystart="54" bodyend="-1"/>
 100       </memberdef>
 101       </sectiondef>
 102     <briefdescription>
 103     </briefdescription>
 104     <detaileddescription>
 105     </detaileddescription>
 106     <location file="/home/ubuntu/boost/boost/geometry/geometries/register/linestring.hpp"/>
 107   </compounddef>
 108 </doxygen>