• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/==============================================================================
2    Copyright (C) 2001-2011 Hartmut Kaiser
3    Copyright (C) 2001-2011 Joel de Guzman
4
5    Distributed under the Boost Software License, Version 1.0. (See accompanying
6    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
7===============================================================================/]
8
9[section Module]
10
11[heading Module Headers]
12
13    #include <boost/spirit/xxx.hpp>
14
15Also, see __include_structure__.
16
17[/------------------------------------------------------------------------------]
18[section XXX]
19
20[heading Description]
21
22Description of XXX
23
24[heading Header]
25
26    #include <boost/spirit/xxx.hpp>
27
28    ...
29
30Also, see __include_structure__.
31
32[heading Namespace]
33
34[table
35    [[Name]]
36    [[`boost::spirit::xx`]]
37]
38
39[heading Synopsis]
40
41    template <typename T>
42    struct XXX;
43
44[heading Template parameters]
45
46[table
47    [[Parameter]            [Description]               [Default]]
48    [[`T`]                  [What is T]                 []]
49]
50
51[heading Model of]
52
53[variablelist Notation
54    [[`xxx`]     [An XXX]]
55]
56
57[heading Expression Semantics]
58
59Semantics of an expression is defined only where it differs from, or is not
60defined in _concept-of_XXX_.
61
62[table
63    [[Expression]       [Semantics]]
64    [[`xxx`]            [Semantics of `xxx`]]
65]
66
67[heading Attributes]
68
69See __qi_comp_attr_notation__.
70
71[table
72    [[Expression]       [Attribute]]
73    [[`xxx`]            [Attribute of `xxx`]]
74]
75
76[heading Complexity]
77
78Big-O complexity of the parser
79
80[heading Example]
81
82Real example code. Use Quickbook import mechanism to link to actual
83working code snippets here.
84
85[endsect] [/ XXX]
86
87[endsect] [/ Module]
88