Split kdecoration and kwineffects libraries as two modules for doxygen.

svn path=/trunk/KDE/kdebase/workspace/; revision=762274
This commit is contained in:
Luboš Luňák 2008-01-16 18:13:24 +00:00
parent ea8a3ed648
commit 3c3b5f4b2d
11 changed files with 47 additions and 7 deletions

View file

@ -1,11 +1,11 @@
/** @mainpage KWin Libraries /** @mainpage KWin Libraries
There are two libraries provided: libkdecorations and libkwineffects. There are two libraries provided:
<p> <p>
libkdecorations is a library for implementing window decoration plugins @ref kdecoration is a library for implementing window decoration plugins
for KWin. for KWin.
libkwineffects is a library for implementing window transition effect @ref kwineffects is a library for implementing window transition effect
plugins for KWin. plugins for KWin.
@authors @authors

View file

@ -42,6 +42,9 @@
#include "kcommondecoration.moc" #include "kcommondecoration.moc"
/** @addtogroup kdecoration */
/** @{ */
KCommonDecoration::KCommonDecoration(KDecorationBridge* bridge, KDecorationFactory* factory) KCommonDecoration::KCommonDecoration(KDecorationBridge* bridge, KDecorationFactory* factory)
: m_previewWidget(0), : m_previewWidget(0),
btnHideMinWidth(200), btnHideMinWidth(200),

View file

@ -28,6 +28,9 @@
#include <QtGui/QAbstractButton> #include <QtGui/QAbstractButton>
#include "kdecoration.h" #include "kdecoration.h"
/** @addtogroup kdecoration */
/** @{ */
class KDecorationBridge; class KDecorationBridge;
class KDecorationFactory; class KDecorationFactory;
@ -441,6 +444,8 @@ class KWIN_EXPORT KCommonDecorationButton : public QAbstractButton
KCommonDecorationButtonPrivate *d; KCommonDecorationButtonPrivate *d;
}; };
/** @} */
#endif // KCOMMONDECORATION_H #endif // KCOMMONDECORATION_H
// kate: space-indent on; indent-width 4; mixedindent off; indent-mode cstyle; // kate: space-indent on; indent-width 4; mixedindent off; indent-mode cstyle;

View file

@ -32,13 +32,18 @@ DEALINGS IN THE SOFTWARE.
#include <netwm_def.h> #include <netwm_def.h>
#include <QtGui/QMouseEvent> #include <QtGui/QMouseEvent>
#define KWIN_EXPORT KDE_EXPORT
/** @defgroup kdecoration KWin decorations library */
/** @addtogroup kdecoration */
/** @{ */
class KDecorationOptionsPrivate; class KDecorationOptionsPrivate;
class KDecorationBridge; class KDecorationBridge;
class KDecorationPrivate; class KDecorationPrivate;
class KDecorationFactory; class KDecorationFactory;
#define KWIN_EXPORT KDE_EXPORT
/** /**
* This class provides a namespace for all decoration related classes. * This class provides a namespace for all decoration related classes.
* All shared types are defined here. * All shared types are defined here.
@ -867,4 +872,6 @@ inline int KDecoration::height() const
return geometry().height(); return geometry().height();
} }
/** @} */
#endif #endif

View file

@ -106,4 +106,6 @@ class KDecorationBridge : public KDecorationDefines
virtual void grabXServer( bool grab ) = 0; virtual void grabXServer( bool grab ) = 0;
}; };
/** @} */
#endif #endif

View file

@ -73,4 +73,6 @@ class KWIN_EXPORT KDecorationPlugins
*/ */
/** @} */
#endif #endif

View file

@ -27,6 +27,9 @@ DEALINGS IN THE SOFTWARE.
#include "kdecoration.h" #include "kdecoration.h"
/** @addtogroup kdecoration */
/** @{ */
class KDecoration; class KDecoration;
class KDecorationBridge; class KDecorationBridge;
class KDecorationFactoryPrivate; class KDecorationFactoryPrivate;
@ -116,5 +119,7 @@ inline const KDecorationOptions* KDecorationFactory::options()
{ {
return KDecoration::options(); return KDecoration::options();
} }
/** @} */
#endif #endif

View file

@ -38,6 +38,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <assert.h> #include <assert.h>
/** @addtogroup kwineffects */
/** @{ */
#define KWIN_EFFECT_API_MAKE_VERSION( major, minor ) (( major ) << 8 | ( minor )) #define KWIN_EFFECT_API_MAKE_VERSION( major, minor ) (( major ) << 8 | ( minor ))
#define KWIN_EFFECT_API_VERSION_MAJOR 0 #define KWIN_EFFECT_API_VERSION_MAJOR 0
#define KWIN_EFFECT_API_VERSION_MINOR 6 #define KWIN_EFFECT_API_VERSION_MINOR 6
@ -49,6 +52,8 @@ class KConfigGroup;
class KActionCollection; class KActionCollection;
class QKeyEvent; class QKeyEvent;
/** @defgroup kwineffects KWin effects library */
namespace KWin namespace KWin
{ {
@ -882,4 +887,6 @@ double WindowQuad::originalBottom() const
} // namespace } // namespace
/** @} */
#endif // KWINEFFECTS_H #endif // KWINEFFECTS_H

View file

@ -32,11 +32,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <kwinconfig.h> #include <kwinconfig.h>
#define KWIN_EXPORT KDE_EXPORT
namespace KWin namespace KWin
{ {
#define KWIN_EXPORT KDE_EXPORT
enum CompositingType enum CompositingType
{ {
@ -107,6 +107,7 @@ KWIN_EXPORT int displayHeight()
return XDisplayHeight( display(), DefaultScreen( display())); return XDisplayHeight( display(), DefaultScreen( display()));
} }
/** @internal */
class KWIN_EXPORT Extensions class KWIN_EXPORT Extensions
{ {
public: public:

View file

@ -31,6 +31,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <QImage> #include <QImage>
#include <QSize> #include <QSize>
/** @addtogroup kwineffects */
/** @{ */
template< class K, class V > class QHash; template< class K, class V > class QHash;
@ -252,4 +254,6 @@ class KWIN_EXPORT GLRenderTarget
#endif #endif
/** @} */
#endif #endif

View file

@ -24,6 +24,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <kwineffects.h> #include <kwineffects.h>
/** @addtogroup kwineffects */
/** @{ */
namespace KWin namespace KWin
{ {
@ -63,4 +65,6 @@ class KWIN_EXPORT ShaderEffect : public Effect
} // namespace } // namespace
/** @} */
#endif #endif