tdewebdev

History

Timothy Pearson 0348cfd0a9 Finish rename from prior commit		13 years ago
..
Makefile.am	Additional renaming of kde to tde	13 years ago
README.dox	Additional renaming of kde to tde	13 years ago
app.tdevelop	Finish rename from prior commit	13 years ago
kommanderplugin.kdevtemplate	Additional renaming of kde to tde	13 years ago
kommanderplugin.png	Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.	15 years ago
plugin.cpp	rename the following methods:	14 years ago
src-Makefile.am	Rename additional instances of KDE to TDE	13 years ago
widget.cpp	rename the following methods:	14 years ago
widget.h	rename the following methods:	14 years ago

README.dox

/** \class %{APPNAME}
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 bugs in <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&component=YOUR_COMPONENT_NAME&
bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">
YOUR_COMPONENT_NAME at Bugzilla database</a>
\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.

*/