• Skip to content
  • Skip to link menu
Home
KDE Developer's Corner
Sitemap :: Help :: Contact Us Location: Location: Developer Home / Documentation / Library Reference / API Manuals / dox Guide

This file documents what you should do in KDE APIDOX, in particular with reference to examples and grouping.

KDE Specific Tags

  • @bc This tag indicated binary compatibility, much like @since does. The argument after @bc is the scope of binary compatibility (for instance, KDE4). Classes that are not marked with @bc may, in some modules, be flagged as incompatible so that they can be avoided.
    /** This class emulates a Moose. @bc KDE4.2 Compatibility is expected to break with next-generation mooses. */
  • @libs Use this tag to indicate what libraries should be linked in for the given class. Although this is usually the name of the directory the class lives in, this is not always the case.
    /** This class emulates a Moose. @libs @a -lkdeui or use \$(LIB_KDEUI) in the KDE build framework. */

[ Edit ]

API Manuals

  • KDE 3.4
  • KDE 3.5
  • SVN trunk

For Writers

  • dox HOWTO
  • dox Guide
  • dox Policy
  • Doxygen Manual

Global navigation links

  • KDE Home
  • KDE Accessibility Home
  • Description of Access Keys
  • Back to content
  • Back to menu

Search



Maintained by kde.org Webmaster
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal