API dox: document Q_DECLARE_FLAGS-based flags

Summary:
KApiDox & ECMAddQch have been just teached about Q_DECLARE_FLAGS, so the
underlying typedefs are no longer skipped by doxygen, but can be
documented now, allowing links to be generated for these types e.g. when
used as arguments.

The "#" prefix to the enum name in the description text of all the
Q_DECLARE_FLAGS docs seems needed to properly trigger doxygen autolinks.

GIT_SILENT
wilder
Friedrich W. H. Kossebau 6 years ago
parent be28e096c5
commit aa28a2433e
  1. 4
      src/core/kconfig.h
  2. 4
      src/core/kconfigbase.h

@ -77,6 +77,7 @@ public:
* Note that all values other than IncludeGlobals and CascadeConfig are
* convenience definitions for the basic mode.
* Do @em not combine them with anything.
* @see OpenFlags
*/
enum OpenFlag {
IncludeGlobals = 0x01, ///< Blend kdeglobals into the config object.
@ -87,6 +88,9 @@ public:
NoGlobals = CascadeConfig, ///< Cascade to system settings, but omit user's globals.
FullConfig = IncludeGlobals | CascadeConfig ///< Fully-fledged config, including globals and cascading to system settings
};
/**
* Stores a combination of #OpenFlag values.
*/
Q_DECLARE_FLAGS(OpenFlags, OpenFlag)
/**

@ -32,6 +32,7 @@ class KCONFIGCORE_EXPORT KConfigBase
public:
/**
* Flags to control write entry
* @see WriteConfigFlags
*/
enum WriteConfigFlag {
Persistent = 0x01,
@ -60,6 +61,9 @@ public:
*/
};
/**
* Stores a combination of #WriteConfigFlag values.
*/
Q_DECLARE_FLAGS(WriteConfigFlags, WriteConfigFlag)
/**

Loading…
Cancel
Save