static_visitor.xml 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
  3. "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
  4. <!--
  5. Copyright 2003, Eric Friedman, Itay Maman.
  6. Distributed under the Boost Software License, Version 1.0. (See accompanying
  7. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  8. -->
  9. <header name="boost/variant/static_visitor.hpp">
  10. <namespace name="boost">
  11. <class name="static_visitor">
  12. <template>
  13. <template-type-parameter name="ResultType"/>
  14. </template>
  15. <purpose>Convenient base type for static visitors.</purpose>
  16. <description>
  17. <simpara>Denotes the intent of the deriving class as meeting the
  18. requirements of a static visitor of some type. Also exposes the
  19. inner type <code>result_type</code> as required by the
  20. <link linkend="variant.concepts.static-visitor"><emphasis>StaticVisitor</emphasis></link>
  21. concept.</simpara>
  22. <simpara><emphasis role="bold">Notes</emphasis>:
  23. <code>static_visitor</code> is intended for use as a base type only
  24. and is therefore noninstantiable.</simpara>
  25. </description>
  26. <typedef name="result_type">
  27. <type>ResultType</type>
  28. <purpose>Exposes result_type member as required by StaticVisitor concept.</purpose>
  29. </typedef>
  30. </class>
  31. </namespace>
  32. </header>