forked from boostorg/spirit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
concepts_template.qbk
59 lines (37 loc) · 1.39 KB
/
concepts_template.qbk
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
[/==============================================================================
Copyright (C) 2001-2011 Hartmut Kaiser
Copyright (C) 2001-2011 Joel de Guzman
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
===============================================================================/]
[/------------------------------------------------------------------------------]
[section XXX]
[heading Description]
Description of XXX concept
[heading Refinement of]
[:Link to base concept]
[variablelist Notation
[[`xxx`] [An XXX]]
]
[heading Valid Expressions]
(For any XXX the following expressions must be valid:)
In addition to the requirements defined in _XXX-Basic_concept_, for any
XXX the following must be met:
[table
[[Expression] [Semantics] [Return type]]
[[`xxx`] [Semantics of `xxx`] [XXX]]
]
[heading Type Expressions]
[table
[[Expression] [Description]]
[[`XXX`] [Description of `XXX`]]
]
[heading Invariants]
For any XXX xxx the following invariants always hold:
[heading Precondition]
Prior to calling FOO the following preconditions should hold:
[heading Precondition]
Upon return from FOO the following postconditions should hold:
[heading Models]
Links to models of XXX concept
[endsect] [/ XXX Concept]