From 3c3b5f4b2dca61b26190930ecefedf833d08dcf5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lubo=C5=A1=20Lu=C5=88=C3=A1k?= Date: Wed, 16 Jan 2008 18:13:24 +0000 Subject: [PATCH] Split kdecoration and kwineffects libraries as two modules for doxygen. svn path=/trunk/KDE/kdebase/workspace/; revision=762274 --- lib/Mainpage.dox | 6 +++--- lib/kcommondecoration.cpp | 3 +++ lib/kcommondecoration.h | 5 +++++ lib/kdecoration.h | 11 +++++++++-- lib/kdecoration_p.h | 2 ++ lib/kdecoration_plugins_p.h | 2 ++ lib/kdecorationfactory.h | 5 +++++ lib/kwineffects.h | 7 +++++++ lib/kwinglobals.h | 5 +++-- lib/kwinglutils.h | 4 ++++ lib/kwinshadereffect.h | 4 ++++ 11 files changed, 47 insertions(+), 7 deletions(-) diff --git a/lib/Mainpage.dox b/lib/Mainpage.dox index 45a6fb872c..b01bf15ae9 100644 --- a/lib/Mainpage.dox +++ b/lib/Mainpage.dox @@ -1,11 +1,11 @@ /** @mainpage KWin Libraries -There are two libraries provided: libkdecorations and libkwineffects. +There are two libraries provided:

-libkdecorations is a library for implementing window decoration plugins +@ref kdecoration is a library for implementing window decoration plugins for KWin. -libkwineffects is a library for implementing window transition effect +@ref kwineffects is a library for implementing window transition effect plugins for KWin. @authors diff --git a/lib/kcommondecoration.cpp b/lib/kcommondecoration.cpp index 2070fa9a30..2109dc68b5 100644 --- a/lib/kcommondecoration.cpp +++ b/lib/kcommondecoration.cpp @@ -42,6 +42,9 @@ #include "kcommondecoration.moc" +/** @addtogroup kdecoration */ +/** @{ */ + KCommonDecoration::KCommonDecoration(KDecorationBridge* bridge, KDecorationFactory* factory) : m_previewWidget(0), btnHideMinWidth(200), diff --git a/lib/kcommondecoration.h b/lib/kcommondecoration.h index 913431ccad..323945b6a4 100644 --- a/lib/kcommondecoration.h +++ b/lib/kcommondecoration.h @@ -28,6 +28,9 @@ #include #include "kdecoration.h" +/** @addtogroup kdecoration */ +/** @{ */ + class KDecorationBridge; class KDecorationFactory; @@ -441,6 +444,8 @@ class KWIN_EXPORT KCommonDecorationButton : public QAbstractButton KCommonDecorationButtonPrivate *d; }; +/** @} */ + #endif // KCOMMONDECORATION_H // kate: space-indent on; indent-width 4; mixedindent off; indent-mode cstyle; diff --git a/lib/kdecoration.h b/lib/kdecoration.h index 909e457df0..1894208efe 100644 --- a/lib/kdecoration.h +++ b/lib/kdecoration.h @@ -32,13 +32,18 @@ DEALINGS IN THE SOFTWARE. #include #include +#define KWIN_EXPORT KDE_EXPORT + +/** @defgroup kdecoration KWin decorations library */ + +/** @addtogroup kdecoration */ +/** @{ */ + class KDecorationOptionsPrivate; class KDecorationBridge; class KDecorationPrivate; class KDecorationFactory; -#define KWIN_EXPORT KDE_EXPORT - /** * This class provides a namespace for all decoration related classes. * All shared types are defined here. @@ -867,4 +872,6 @@ inline int KDecoration::height() const return geometry().height(); } +/** @} */ + #endif diff --git a/lib/kdecoration_p.h b/lib/kdecoration_p.h index 9b09220124..eb1a9b5c0a 100644 --- a/lib/kdecoration_p.h +++ b/lib/kdecoration_p.h @@ -106,4 +106,6 @@ class KDecorationBridge : public KDecorationDefines virtual void grabXServer( bool grab ) = 0; }; +/** @} */ + #endif diff --git a/lib/kdecoration_plugins_p.h b/lib/kdecoration_plugins_p.h index 8fad2884b0..5aa8da04a3 100644 --- a/lib/kdecoration_plugins_p.h +++ b/lib/kdecoration_plugins_p.h @@ -73,4 +73,6 @@ class KWIN_EXPORT KDecorationPlugins */ +/** @} */ + #endif diff --git a/lib/kdecorationfactory.h b/lib/kdecorationfactory.h index ede8658af1..9815ddd31b 100644 --- a/lib/kdecorationfactory.h +++ b/lib/kdecorationfactory.h @@ -27,6 +27,9 @@ DEALINGS IN THE SOFTWARE. #include "kdecoration.h" +/** @addtogroup kdecoration */ +/** @{ */ + class KDecoration; class KDecorationBridge; class KDecorationFactoryPrivate; @@ -116,5 +119,7 @@ inline const KDecorationOptions* KDecorationFactory::options() { return KDecoration::options(); } + +/** @} */ #endif diff --git a/lib/kwineffects.h b/lib/kwineffects.h index 36d7b39b43..5706b155d1 100644 --- a/lib/kwineffects.h +++ b/lib/kwineffects.h @@ -38,6 +38,9 @@ along with this program. If not, see . #include +/** @addtogroup kwineffects */ +/** @{ */ + #define KWIN_EFFECT_API_MAKE_VERSION( major, minor ) (( major ) << 8 | ( minor )) #define KWIN_EFFECT_API_VERSION_MAJOR 0 #define KWIN_EFFECT_API_VERSION_MINOR 6 @@ -49,6 +52,8 @@ class KConfigGroup; class KActionCollection; class QKeyEvent; +/** @defgroup kwineffects KWin effects library */ + namespace KWin { @@ -882,4 +887,6 @@ double WindowQuad::originalBottom() const } // namespace +/** @} */ + #endif // KWINEFFECTS_H diff --git a/lib/kwinglobals.h b/lib/kwinglobals.h index e1a1a8a360..3990ccbf33 100644 --- a/lib/kwinglobals.h +++ b/lib/kwinglobals.h @@ -32,11 +32,11 @@ along with this program. If not, see . #include +#define KWIN_EXPORT KDE_EXPORT + namespace KWin { -#define KWIN_EXPORT KDE_EXPORT - enum CompositingType { @@ -107,6 +107,7 @@ KWIN_EXPORT int displayHeight() return XDisplayHeight( display(), DefaultScreen( display())); } +/** @internal */ class KWIN_EXPORT Extensions { public: diff --git a/lib/kwinglutils.h b/lib/kwinglutils.h index 1c5e1fe0ea..d1ff4a8812 100644 --- a/lib/kwinglutils.h +++ b/lib/kwinglutils.h @@ -31,6 +31,8 @@ along with this program. If not, see . #include #include +/** @addtogroup kwineffects */ +/** @{ */ template< class K, class V > class QHash; @@ -252,4 +254,6 @@ class KWIN_EXPORT GLRenderTarget #endif +/** @} */ + #endif diff --git a/lib/kwinshadereffect.h b/lib/kwinshadereffect.h index c5884c4ef4..e35c00f3b4 100644 --- a/lib/kwinshadereffect.h +++ b/lib/kwinshadereffect.h @@ -24,6 +24,8 @@ along with this program. If not, see . #include +/** @addtogroup kwineffects */ +/** @{ */ namespace KWin { @@ -63,4 +65,6 @@ class KWIN_EXPORT ShaderEffect : public Effect } // namespace +/** @} */ + #endif