reference_template.qbk 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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. [section Module]
  8. [heading Module Headers]
  9. #include <boost/spirit/xxx.hpp>
  10. Also, see __include_structure__.
  11. [/------------------------------------------------------------------------------]
  12. [section XXX]
  13. [heading Description]
  14. Description of XXX
  15. [heading Header]
  16. #include <boost/spirit/xxx.hpp>
  17. ...
  18. Also, see __include_structure__.
  19. [heading Namespace]
  20. [table
  21. [[Name]]
  22. [[`boost::spirit::xx`]]
  23. ]
  24. [heading Synopsis]
  25. template <typename T>
  26. struct XXX;
  27. [heading Template parameters]
  28. [table
  29. [[Parameter] [Description] [Default]]
  30. [[`T`] [What is T] []]
  31. ]
  32. [heading Model of]
  33. [variablelist Notation
  34. [[`xxx`] [An XXX]]
  35. ]
  36. [heading Expression Semantics]
  37. Semantics of an expression is defined only where it differs from, or is not
  38. defined in _concept-of_XXX_.
  39. [table
  40. [[Expression] [Semantics]]
  41. [[`xxx`] [Semantics of `xxx`]]
  42. ]
  43. [heading Attributes]
  44. See __qi_comp_attr_notation__.
  45. [table
  46. [[Expression] [Attribute]]
  47. [[`xxx`] [Attribute of `xxx`]]
  48. ]
  49. [heading Complexity]
  50. Big-O complexity of the parser
  51. [heading Example]
  52. Real example code. Use Quickbook import mechanism to link to actual
  53. working code snippets here.
  54. [endsect] [/ XXX]
  55. [endsect] [/ Module]