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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
// ==========================================================================
// %(TITLE)s
// ==========================================================================
// Copyright (c) 2006-2026, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of Knut Reinert or the FU Berlin nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: %(AUTHOR)s
// ==========================================================================
#ifndef %(HEADER_GUARD)s
#define %(HEADER_GUARD)s
namespace seqan2 {
// ============================================================================
// Forwards
// ============================================================================
// ============================================================================
// Tags, Classes, Enums
// ============================================================================
/**
.Concept:MyConcept
..
..include:seqan/%(NAME)s.h
*/
// If your define a lot of very generic functions for our concept, consider
// putting it into its own directory.
/**
.Class.MyClass
..concept:Concept.MyConcept
..summary:This is my class.
..cat:My Classes
..signature:MyClass<TSpec>
..param.TSpec:Tag to select the specialization.
...default:MyTag
..include:seqan/%(NAME)s.h
*/
// NOTE: Assigning classes to concepts is optional.
// struct Our_;
// typedef Tag<Our_> Our;
// template <typename TSpec = Our>
// class MyClass;
/*
.Spec.Our MyClass
..cat:My Classes
..general:Class.MyClass
..summary:This is the "our" specialization of my class!
..signature:MyClass<Our>
..include:seqan/%(NAME)s.h
.Memfunc.Our MyClass#MyClass
..cat:My Classes
..class:Spec.Our MyClass
..signature:Class()
..signature:Class(foo, barBaz)
..param.foo:A foo parameter.
...type:Spec.CharString
..param.barBaz:Another parameter.
...type:nolink:$int$
*/
// template <>
// class MyClass<Our>
// {
// public:
// // ...
// };
// ============================================================================
// Metafunctions
// ============================================================================
// ----------------------------------------------------------------------------
// Metafunction Value
// ----------------------------------------------------------------------------
///.Metafunction.Value.param.T.value:Class.MyClass
// template <typename TSpec>
// struct Value<MyClass<TSpec> >
// {
// typedef int Type;
// };
// ============================================================================
// Functions
// ============================================================================
// ----------------------------------------------------------------------------
// Function someFunction()
// ----------------------------------------------------------------------------
/**
.Function.someFunction
..concept:Concept.MyConcept
..cat:My Classes
..signature:someFunction(obj)
..summary:Executes some functionality on a @Class.MyClass@.
..param.obj:Object to call function on.
...type:Class.MyClass
..returns:$void$
..include:seqan/%(NAME)s.h
*/
// NOTE: Functions can belong to concepts but do not have to. You can use
// function documentations and link them to concepts in a concept_name.h
// header to document your concept.
// template <typename TSpec>
// inline void
// someFunction(MyClass<TSpec> const & /*obj*/)
// {
// return;
// }
} // namespace seqan2
#endif // %(HEADER_GUARD)s
|
