KDevelop API Documentation

How to document KDevelop parts

You should add a README and a README.dox file to your part (KDevPlugin).

On the README file put this text:

Please read the on-line, automaticaly updated KDevelop API documentation at: http://www.kdevelop.org or read the README.dox file.

On the README.dox file put the mandatory information:

/** \class yourPartClassName 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. ... /*

IMPORTANT: You should replace yourPartClassName with the name of the class that implements your part.

On the area marked with ... you can add optional informations. Here is an example of that:

/** \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=kdevelop&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. */

All these infos are optional and you should only add the link to the bugzilla database if YOUR_COMPONENT_NAME has been defined in that database.

KDE Logo
This file is part of the documentation for KDevelop Version 3.0.4.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Oct 6 17:39:31 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003