customization_point_template.qbk 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. [/==============================================================================
  2. Copyright (C) 2001-2011 Hartmut Kaiser
  3. Copyright (C) 2001-2011 Joel de Guzman
  4. Distributed under the Boost Software License, Version 1.0. (See accompanying
  5. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  6. ===============================================================================/]
  7. [/////////////////////////////////////////////////////////////////////////////]
  8. [section:Customization_Point XXX]
  9. [heading Customization_Point]
  10. Short description here...
  11. [heading Module Headers]
  12. #include <boost/spirit/xxx.hpp>
  13. Also, see __include_structure__.
  14. [note This header file does not need to be included directly by any user
  15. program as it is normally included by other Spirit header files relying
  16. on its content.]
  17. [heading Namespace]
  18. [table
  19. [[Name]]
  20. [[`boost::spirit::xxx`]]
  21. ]
  22. [heading Synopsis]
  23. template <typename T>
  24. struct XXX;
  25. [heading Template parameters]
  26. [table
  27. [[Parameter] [Description] [Default]]
  28. [[`T`] [What is T] []]
  29. ]
  30. [variablelist Notation
  31. [[`xxx`] [An XXX]]
  32. ]
  33. [heading Expression Semantics]
  34. [table
  35. [[Expression] [Semantics]]
  36. [[`xxx`] [Semantics of `xxx`]]
  37. ]
  38. [heading Predefined Specializations]
  39. [table
  40. [[Type] [Semantics]]
  41. [[`xxx`] [Summary of the specialization.]]
  42. ]
  43. [heading When to implement]
  44. Describe when this customization point needs to be implemented by the user.
  45. [heading Related Attribute Customization Points]
  46. If this customization point is implemented, the following other customization
  47. points need to be implemented as well.
  48. [table
  49. [[Name] [When to implement]]
  50. ]
  51. [heading Example]
  52. Real example code. Use Quickbook import mechanism to link to actual
  53. working code snippets here.
  54. [endsect] [/ XXX]