• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/==============================================================================
2    Copyright (C) <year> <name>
3
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 <name of component>]
9
10[heading Description]
11
12[/ describe the component here]
13
14[heading Header]
15
16    #include <boost/spirit/repository/include/...>
17
18[heading Synopsis]
19
20[/ short usage synopsis]
21
22[heading Parameters]
23
24[table
25    [[Parameter]               [Description]]
26    [[parameter in synopsis]   [describe parameter]]
27]
28
29[heading Attribute]
30
31[/ describe the rules for attribute construction and propagation of your
32   component, use the same notation as used in the main Spirit docs]
33
34[heading Example]
35
36[/ describe some examples here, use uiqckbooks import feature to show the code]
37
38[endsect]
39