blob: 452db8ca8894e9fd462799a7d9a9d30109dbe35c (
plain)
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
|
/** \class FilterPart
Put a brief description here, the brief description ends at the first dot.
Put a more detailed description of your part in these lines. It can span
over several lines. You can even use some html commands in these lines like:
<code>This is code</code>, html links <a href="http://somelocation">link text</a>,
and images.
\authors <a href="mailto:$EMAIL$">$AUTHOR$</a>
\authors <a href="mailto:2nd author AT provider.com">2nd author full name</a>
...
\authors <a href="mailto:nth author AT provider.com">nth author full name</a>
\maintainer <a href="mailto:$EMAIL$">$AUTHOR$</a>
\maintainer <a href="mailto:2nd maintainer AT provider.com">2nd maintainer full name</a>
...
\maintainer <a href="mailto:nth maintainer AT provider.com">nth maintainer full name</a>
\feature Describe the first feature
\feature Describe the second feature
...
\feature Describe the last feature
\bug Describe a the 1st bug that you know of, but probably hasn't been reported yet.
..
\bug Describe a the nth bug that you know of, but probably hasn't been reported yet.
\requirement Describe a the 1st requirement of your part.
\requirement Describe a the 2nd requirement of your part.
...
\requirement Describe a the nth requirement of your part.
\todo Describe a the 1st TODO of your part.
\todo Describe a the 2nd TODO of your part.
...
\todo Describe a the nth TODO of your part.
\faq <b>First frequenly asked question about your part ?</b> Answer.
\faq <b>Second frequenly asked question about your part ?</b> Answer.
...
\faq <b>Last frequenly asked question about your part ?</b> Answer.
\note First note text.
\note Second note text.
...
\note Last note text.
\warning First warning text.
\warning Second warning text.
...
\warning Last warning text.
*/
|
