From aa28a2433e55cc909c49ed4dbb7ce5c48baa1b24 Mon Sep 17 00:00:00 2001 From: "Friedrich W. H. Kossebau" Date: Mon, 20 Apr 2020 02:57:02 +0200 Subject: 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 --- src/core/kconfig.h | 4 ++++ src/core/kconfigbase.h | 4 ++++ 2 files changed, 8 insertions(+) (limited to 'src') diff --git a/src/core/kconfig.h b/src/core/kconfig.h index 2693f91e..1c9d23d7 100644 --- a/src/core/kconfig.h +++ b/src/core/kconfig.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) /** diff --git a/src/core/kconfigbase.h b/src/core/kconfigbase.h index 927eb78a..12a8e875 100644 --- a/src/core/kconfigbase.h +++ b/src/core/kconfigbase.h @@ -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) /** -- cgit v1.2.1