|
|
On Friday 10 November 2006 6:18 am, Till Oliver Knoll wrote:
> Thomas Fjellstrom schrieb:
> > ...
> > Seems to be a hard thing to learn, since I've NEVER seen a decent set of
> > documents written with it.
>
> /*!
> * \brief This response tries to show how a typical Doxydoc
> * could look like.
> *
> * If you are able to write \em JavaDoc and know a little
> * bit about Html then you are that close to be able
> * to write Doxydoc! In fact you could write your doc
> * entirely in JavaDoc style only!
> *
> * \note Don't forget to use the Doxywizard (GUI) as to create the
> * initial Doxydox project file.
> *
> * \param question
> * An EMail containing the actual question to
> * <address>qt-interest@xxxxxxxxxxxxx</address>
> * \return the answer EMail to
> * <address>qt-interest@xxxxxxxxxxxxx</address>
> * \sa WhyPeopleAreLazyWritingGood#Documents
> * \sa http://www.stack.nl/~dimitri/doxygen/docblocks.html
> * \sa http://www.stack.nl/~dimitri/doxygen/commands.html
> * \sa http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
> * \warning You might actually get addicted to write good documentation
> * ;)
> * \author Oliver Knoll
> * \date 2006-11-10
> */
Good tips, too bad noone seems to follow them.
>
> --
> To unsubscribe - send a mail to qt-interest-request@xxxxxxxxxxxxx with
> "unsubscribe" in the subject or the body. List archive and information:
> http://lists.trolltech.com/qt-interest/
--
Thomas Fjellstrom
tfjellstrom@xxxxxxxxxxxxxxx
--
To unsubscribe - send a mail to qt-interest-request@xxxxxxxxxxxxx with
"unsubscribe" in the subject or the body.
List archive and information: http://lists.trolltech.com/qt-interest/
|
|