]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
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 | [/////////////////////////////////////////////////////////////////////////////] | |
10 | [section:Customization_Point XXX] | |
11 | ||
12 | [heading Customization_Point] | |
13 | ||
14 | Short description here... | |
15 | ||
16 | [heading Module Headers] | |
17 | ||
18 | #include <boost/spirit/xxx.hpp> | |
19 | ||
20 | Also, see __include_structure__. | |
21 | ||
22 | [note This header file does not need to be included directly by any user | |
23 | program as it is normally included by other Spirit header files relying | |
24 | on its content.] | |
25 | ||
26 | [heading Namespace] | |
27 | ||
28 | [table | |
29 | [[Name]] | |
30 | [[`boost::spirit::xxx`]] | |
31 | ] | |
32 | ||
33 | [heading Synopsis] | |
34 | ||
35 | template <typename T> | |
36 | struct XXX; | |
37 | ||
38 | [heading Template parameters] | |
39 | ||
40 | [table | |
41 | [[Parameter] [Description] [Default]] | |
42 | [[`T`] [What is T] []] | |
43 | ] | |
44 | ||
45 | [variablelist Notation | |
46 | [[`xxx`] [An XXX]] | |
47 | ] | |
48 | ||
49 | [heading Expression Semantics] | |
50 | ||
51 | [table | |
52 | [[Expression] [Semantics]] | |
53 | [[`xxx`] [Semantics of `xxx`]] | |
54 | ] | |
55 | ||
56 | [heading Predefined Specializations] | |
57 | ||
58 | [table | |
59 | [[Type] [Semantics]] | |
60 | [[`xxx`] [Summary of the specialization.]] | |
61 | ] | |
62 | ||
63 | [heading When to implement] | |
64 | ||
65 | Describe when this customization point needs to be implemented by the user. | |
66 | ||
67 | [heading Related Attribute Customization Points] | |
68 | ||
69 | If this customization point is implemented, the following other customization | |
70 | points need to be implemented as well. | |
71 | ||
72 | [table | |
73 | [[Name] [When to implement]] | |
74 | ] | |
75 | ||
76 | [heading Example] | |
77 | ||
78 | Real example code. Use Quickbook import mechanism to link to actual | |
79 | working code snippets here. | |
80 | ||
81 | [endsect] [/ XXX] | |
82 |