← Back to branch summary

~ubuntu-branches/debian/sid/kdevelop/sid

« back to all changes in this revision

Viewing changes to languages/cpp/app_templates/kdevpart2/README.dox

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Lainé
  • Date: 2010-05-05 07:21:55 UTC
  • mfrom: (1.2.3 upstream) (5.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100505072155-h78lx19pu04sbhtn
Tags: 4:4.0.0-2
http://bugs.debian.org/579947
http://bugs.debian.org/481832
http://bugs.debian.org/562410
http://bugs.debian.org/546961
* Upload to unstable (Closes: #579947, #481832).
* Acknowledge obsolete NMU fixes (Closes: #562410, #546961).

Show diffs side-by-side

added added

removed removed

Lines of Context:
languages/cpp/app_templates/kdevpart2/README.dox
1
 
/** \class %{APPNAME}
2
 
Put a brief description here, the brief description ends at the first dot.
3
 
Put a more detailed description of your part in these lines. It can span
4
 
over several lines. You can even use some html commands in these lines like:
5
 
<code>This is code</code>, html links <a href="http://somelocation">link text</a>,
6
 
and images.
7
 
 
8
 
\authors <a href="mailto:%{EMAIL}">%{AUTHOR}</a>
9
 
\authors <a href="mailto:2nd author AT provider.com">2nd author full name</a>
10
 
...
11
 
\authors <a href="mailto:nth author AT provider.com">nth author full name</a>
12
 
 
13
 
\maintainer <a href="mailto:%{EMAIL}">%{AUTHOR}</a>
14
 
\maintainer <a href="mailto:2nd maintainer AT provider.com">2nd maintainer full name</a>
15
 
...
16
 
\maintainer <a href="mailto:nth maintainer AT provider.com">nth maintainer full name</a>
17
 
 
18
 
\feature Describe the first feature
19
 
\feature Describe the second feature
20
 
...
21
 
\feature Describe the last feature
22
 
 
23
 
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&component=YOUR_COMPONENT_NAME&
24
 
bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">
25
 
YOUR_COMPONENT_NAME at Bugzilla database</a>
26
 
\bug Describe a the 1st bug that you know of, but probably hasn't been reported yet.
27
 
..
28
 
\bug Describe a the nth bug that you know of, but probably hasn't been reported yet.
29
 
 
30
 
\requirement Describe a the 1st requirement of your part.
31
 
\requirement Describe a the 2nd requirement of your part.
32
 
...
33
 
\requirement Describe a the nth requirement of your part.
34
 
 
35
 
\todo Describe a the 1st TODO of your part.
36
 
\todo Describe a the 2nd TODO of your part.
37
 
...
38
 
\todo Describe a the nth TODO of your part.
39
 
 
40
 
\faq <b>First frequenly asked question about your part ?</b> Answer.
41
 
\faq <b>Second frequenly asked question about your part ?</b> Answer.
42
 
...
43
 
\faq <b>Last frequenly asked question about your part ?</b> Answer.
44
 
 
45
 
\note First note text.
46
 
\note Second note text.
47
 
...
48
 
\note Last note text.
49
 
 
50
 
\warning First warning text.
51
 
\warning Second warning text.
52
 
...
53
 
\warning Last warning text.
54
 
 
55
 
*/