Fix doxygen generation

Doxygen doesn't like our callback listener at all. We need to hide
it from doxygen, otherwise docu doesn't get generated.
This commit is contained in:
Martin Gräßlin 2015-09-09 16:39:50 +02:00
parent 30122f1e05
commit 5e3bb70612
22 changed files with 62 additions and 4 deletions

View file

@ -55,10 +55,12 @@ private:
static const struct org_kde_kwin_blur_manager_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_blur_manager_interface BlurManagerInterface::Private::s_interface = {
createCallback,
unsetCallback
};
#endif
BlurManagerInterface::Private::Private(BlurManagerInterface *q, Display *d)
: Global::Private(d, &org_kde_kwin_blur_manager_interface, s_version)
@ -155,11 +157,13 @@ private:
static const struct org_kde_kwin_blur_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_blur_interface BlurInterface::Private::s_interface = {
commitCallback,
setRegionCallback,
releaseCallback
};
#endif
void BlurInterface::Private::commitCallback(wl_client *client, wl_resource *resource)
{

View file

@ -58,10 +58,12 @@ CompositorInterface::Private::Private(CompositorInterface *q, Display *d)
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_compositor_interface CompositorInterface::Private::s_interface = {
createSurfaceCallback,
createRegionCallback
};
#endif
CompositorInterface::CompositorInterface(Display *display, QObject *parent)
: Global(new Private(this, display), parent)

View file

@ -55,10 +55,12 @@ private:
static const struct org_kde_kwin_contrast_manager_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_contrast_manager_interface ContrastManagerInterface::Private::s_interface = {
createCallback,
unsetCallback
};
#endif
ContrastManagerInterface::Private::Private(ContrastManagerInterface *q, Display *d)
: Global::Private(d, &org_kde_kwin_contrast_manager_interface, s_version)
@ -164,6 +166,7 @@ private:
static const struct org_kde_kwin_contrast_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_contrast_interface ContrastInterface::Private::s_interface = {
commitCallback,
setRegionCallback,
@ -172,6 +175,7 @@ const struct org_kde_kwin_contrast_interface ContrastInterface::Private::s_inter
setSaturationCallback,
releaseCallback
};
#endif
void ContrastInterface::Private::commitCallback(wl_client *client, wl_resource *resource)
{

View file

@ -62,11 +62,13 @@ private:
static const struct wl_data_device_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_data_device_interface DataDeviceInterface::Private::s_interface = {
startDragCallback,
setSelectionCallback,
releaseCallback
};
#endif
DataDeviceInterface::Private::Private(SeatInterface *seat, DataDeviceInterface *q, DataDeviceManagerInterface *manager, wl_resource *parentResource)
: Resource::Private(q, manager, parentResource, &wl_data_device_interface, &s_interface)

View file

@ -52,10 +52,12 @@ private:
static const struct wl_data_device_manager_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_data_device_manager_interface DataDeviceManagerInterface::Private::s_interface = {
createDataSourceCallback,
getDataDeviceCallback
};
#endif
DataDeviceManagerInterface::Private::Private(DataDeviceManagerInterface *q, Display *d)
: Global::Private(d, &wl_data_device_manager_interface, s_version)

View file

@ -51,11 +51,13 @@ private:
static const struct wl_data_offer_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_data_offer_interface DataOfferInterface::Private::s_interface = {
acceptCallback,
receiveCallback,
destroyCallback
};
#endif
DataOfferInterface::Private::Private(DataSourceInterface *source, DataDeviceInterface *parentInterface, DataOfferInterface *q, wl_resource *parentResource)
: Resource::Private(q, nullptr, parentResource, &wl_data_offer_interface, &s_interface)

View file

@ -52,10 +52,12 @@ private:
const static struct wl_data_source_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_data_source_interface DataSourceInterface::Private::s_interface = {
offerCallback,
destroyCallack
};
#endif
DataSourceInterface::Private::Private(DataSourceInterface *q, DataDeviceManagerInterface *parent, wl_resource *parentResource)
: Resource::Private(q, parent, parentResource, &wl_data_source_interface, &s_interface)

View file

@ -68,12 +68,14 @@ private:
FakeInputDevice *q;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_fake_input_interface FakeInputInterface::Private::s_interface = {
authenticateCallback,
pointerMotionCallback,
buttonCallback,
axisCallback
};
#endif
FakeInputInterface::Private::Private(FakeInputInterface *q, Display *d)
: Global::Private(d, &org_kde_kwin_fake_input_interface, s_version)

View file

@ -72,9 +72,11 @@ private:
static const struct org_kde_kwin_idle_timeout_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_idle_interface IdleInterface::Private::s_interface = {
getIdleTimeoutCallback
};
#endif
IdleInterface::Private::Private(IdleInterface *q, Display *d)
: Global::Private(d, &org_kde_kwin_idle_interface, s_version)
@ -121,10 +123,12 @@ IdleInterface::IdleInterface(Display *display, QObject *parent)
IdleInterface::~IdleInterface() = default;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_idle_timeout_interface IdleTimeoutInterface::Private::s_interface = {
releaseCallback,
simulateUserActivityCallback
};
#endif
IdleTimeoutInterface::Private::Private(SeatInterface *seat, IdleTimeoutInterface *q, IdleInterface *manager, wl_resource *parentResource)
: Resource::Private(q, manager, parentResource, &org_kde_kwin_idle_timeout_interface, &s_interface)

View file

@ -62,9 +62,11 @@ KeyboardInterface::Private::Private(SeatInterface *s, wl_resource *parentResourc
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_keyboard_interface KeyboardInterface::Private::s_interface {
releaseCallback
};
#endif
KeyboardInterface::KeyboardInterface(SeatInterface *parent, wl_resource *parentResource)
: Resource(new Private(parent, parentResource, this), parent)

View file

@ -57,10 +57,11 @@ PlasmaShellInterface::Private::Private(PlasmaShellInterface *q, Display *d)
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_plasma_shell_interface PlasmaShellInterface::Private::s_interface = {
createSurfaceCallback
};
#endif
class PlasmaShellSurfaceInterface::Private : public Resource::Private
@ -148,6 +149,7 @@ PlasmaShellSurfaceInterface::Private::Private(PlasmaShellSurfaceInterface *q, Pl
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_plasma_surface_interface PlasmaShellSurfaceInterface::Private::s_interface = {
destroyCallback,
setOutputCallback,
@ -155,6 +157,7 @@ const struct org_kde_plasma_surface_interface PlasmaShellSurfaceInterface::Priva
setRoleCallback,
setPanelBehaviorCallback
};
#endif
PlasmaShellSurfaceInterface::PlasmaShellSurfaceInterface(PlasmaShellInterface *shell, SurfaceInterface *parent, wl_resource *parentResource)
: Resource(new Private(this, shell, parent, parentResource), parent)

View file

@ -106,10 +106,12 @@ PlasmaWindowManagementInterface::Private::Private(PlasmaWindowManagementInterfac
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_plasma_window_management_interface PlasmaWindowManagementInterface::Private::s_interface = {
showDesktopCallback,
getWindowCallback
};
#endif
void PlasmaWindowManagementInterface::Private::sendShowingDesktopState()
{
@ -234,11 +236,13 @@ PlasmaWindowInterface *PlasmaWindowManagementInterface::createWindow(QObject *pa
return window;
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_plasma_window_interface PlasmaWindowInterface::Private::s_interface = {
setStateCallback,
setVirtualDesktopCallback,
closeCallback
};
#endif
PlasmaWindowInterface::Private::Private(PlasmaWindowManagementInterface *wm, PlasmaWindowInterface *q)
: q(q)

View file

@ -91,10 +91,12 @@ void PointerInterface::Private::setCursor(quint32 serial, SurfaceInterface *surf
}
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_pointer_interface PointerInterface::Private::s_interface = {
setCursorCallback,
releaseCallback
};
#endif
PointerInterface::PointerInterface(SeatInterface *parent, wl_resource *parentResource)
: Resource(new Private(parent, parentResource, this), parent)

View file

@ -49,11 +49,13 @@ private:
static const struct wl_region_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_region_interface RegionInterface::Private::s_interface = {
destroyCallback,
addCallback,
subtractCallback
};
#endif
RegionInterface::Private::Private(CompositorInterface *compositor, RegionInterface *q, wl_resource *parentResource)
: Resource::Private(q, compositor, parentResource, &wl_region_interface, &s_interface)

View file

@ -49,11 +49,13 @@ SeatInterface::Private::Private(SeatInterface *q, Display *display)
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_seat_interface SeatInterface::Private::s_interface = {
getPointerCallback,
getKeyboardCallback,
getTouchCallback
};
#endif
SeatInterface::SeatInterface(Display *display, QObject *parent)
: Global(new Private(this, display), parent)

View file

@ -57,10 +57,11 @@ QtSurfaceExtensionInterface::Private::Private(QtSurfaceExtensionInterface *q, Di
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct qt_surface_extension_interface QtSurfaceExtensionInterface::Private::s_interface = {
createSurfaceCallback
};
#endif
class QtExtendedSurfaceInterface::Private : public Resource::Private
@ -140,6 +141,7 @@ QtExtendedSurfaceInterface::Private::Private(QtExtendedSurfaceInterface *q, QtSu
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct qt_extended_surface_interface QtExtendedSurfaceInterface::Private::s_interface = {
updateGenericPropertyCallback,
setContentOrientationMaskCallback,
@ -147,6 +149,7 @@ const struct qt_extended_surface_interface QtExtendedSurfaceInterface::Private::
raiseCallback,
lowerCallback
};
#endif
void QtExtendedSurfaceInterface::Private::lowerCallback(wl_client *client, wl_resource *resource)
{

View file

@ -56,10 +56,11 @@ ShellInterface::Private::Private(ShellInterface *q, Display *d)
{
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_shell_interface ShellInterface::Private::s_interface = {
createSurfaceCallback
};
#endif
class ShellSurfaceInterface::Private : public Resource::Private
@ -166,6 +167,7 @@ ShellSurfaceInterface::Private::Private(ShellSurfaceInterface *q, ShellInterface
pingTimer->setInterval(1000);
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_shell_surface_interface ShellSurfaceInterface::Private::s_interface = {
pongCallback,
moveCallback,
@ -178,6 +180,7 @@ const struct wl_shell_surface_interface ShellSurfaceInterface::Private::s_interf
setTitleCallback,
setClassCallback
};
#endif
ShellSurfaceInterface::ShellSurfaceInterface(ShellInterface *shell, SurfaceInterface *parent, wl_resource *parentResource)
: Resource(new Private(this, shell, parent, parentResource), parent)

View file

@ -54,10 +54,12 @@ private:
static const struct org_kde_kwin_shadow_manager_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_shadow_manager_interface ShadowManagerInterface::Private::s_interface = {
createCallback,
unsetCallback
};
#endif
ShadowManagerInterface::Private::Private(ShadowManagerInterface *q, Display *d)
: Global::Private(d, &org_kde_kwin_shadow_manager_interface, s_version)
@ -188,6 +190,7 @@ private:
static const struct org_kde_kwin_shadow_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct org_kde_kwin_shadow_interface ShadowInterface::Private::s_interface = {
commitCallback,
attachLeftCallback,
@ -203,6 +206,7 @@ const struct org_kde_kwin_shadow_interface ShadowInterface::Private::s_interface
offsetRightCallback,
offsetBottomCallback,
};
#endif
void ShadowInterface::Private::commitCallback(wl_client *client, wl_resource *resource)
{

View file

@ -53,10 +53,12 @@ private:
static const struct wl_subcompositor_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_subcompositor_interface SubCompositorInterface::Private::s_interface = {
destroyCallback,
subsurfaceCallback
};
#endif
SubCompositorInterface::Private::Private(SubCompositorInterface *q, Display *d)
: Global::Private(d, &wl_subcompositor_interface, s_version)
@ -124,6 +126,7 @@ SubCompositorInterface::SubCompositorInterface(Display *display, QObject *parent
SubCompositorInterface::~SubCompositorInterface() = default;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_subsurface_interface SubSurfaceInterface::Private::s_interface = {
destroyCallback,
setPositionCallback,
@ -132,6 +135,7 @@ const struct wl_subsurface_interface SubSurfaceInterface::Private::s_interface =
setSyncCallback,
setDeSyncCallback
};
#endif
SubSurfaceInterface::Private::Private(SubSurfaceInterface *q, SubCompositorInterface *compositor, wl_resource *parentResource)
: Resource::Private(q, compositor, parentResource, &wl_subsurface_interface, &s_interface)

View file

@ -142,6 +142,7 @@ void SurfaceInterface::Private::setContrast(const QPointer<ContrastInterface> &c
pending.contrastIsSet = true;
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_surface_interface SurfaceInterface::Private::s_interface = {
destroyCallback,
attachCallback,
@ -153,6 +154,7 @@ const struct wl_surface_interface SurfaceInterface::Private::s_interface = {
bufferTransformCallback,
bufferScaleCallback
};
#endif
SurfaceInterface::SurfaceInterface(CompositorInterface *parent, wl_resource *parentResource)
: Resource(new Private(this, parent, parentResource))

View file

@ -836,6 +836,7 @@ void Generator::generateServerPrivateResourceClass(const Interface &interface)
void Generator::generateServerPrivateInterfaceClass(const Interface &interface)
{
*m_stream.localData() << QStringLiteral("#ifndef DOXYGEN_SHOULD_SKIP_THIS\n");
*m_stream.localData() << QStringLiteral("const struct %2_interface %1::Private::s_interface = {\n").arg(interface.kwaylandServerName()).arg(interface.name());
bool first = true;
for (auto r: interface.requests()) {
@ -846,7 +847,7 @@ void Generator::generateServerPrivateInterfaceClass(const Interface &interface)
}
*m_stream.localData() << QStringLiteral(" %1Callback").arg(toCamelCase(r.name()));
}
*m_stream.localData() << QStringLiteral("\n};\n\n");
*m_stream.localData() << QStringLiteral("\n};\n#endif\n\n");
}
void Generator::generateServerPrivateResourceCtorDtorClass(const Interface &interface)

View file

@ -51,9 +51,11 @@ private:
static const struct wl_touch_interface s_interface;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const struct wl_touch_interface TouchInterface::Private::s_interface = {
releaseCallback
};
#endif
TouchInterface::Private::Private(SeatInterface *parent, wl_resource *parentResource, TouchInterface *q)
: Resource::Private(q, parent, parentResource, &wl_touch_interface, &s_interface)