Commit bdb138bd authored by Vlad Zahorodnii's avatar Vlad Zahorodnii
Browse files

Remove @since version tags

Currently, we have a mix of Frameworks versions and Plasma versions in
@since tags, which leads to some confusion. Since this is an unstable
library, one cannot rely on since version tags, we are free to add,
change, and remove apis to serve best to kwin requirements. Thus, we can
simply remove all since version tags to fix mixing up different product
versions.
parent a6ef2cc9
......@@ -25,7 +25,6 @@ class AppMenuInterfacePrivate;
*
* This global can be used for clients to bind AppmenuInterface instances
* and notifies when a new one is created
* @since 5.42
*/
class KWAYLANDSERVER_EXPORT AppMenuManagerInterface : public QObject
{
......@@ -54,7 +53,6 @@ private:
* Provides the DBus service name and object path to a AppMenu DBus interface.
* This interface is attached to a wl_surface and provides access to where
* the AppMenu DBus interface is registered.
* @since 5.42
*/
class KWAYLANDSERVER_EXPORT AppMenuInterface : public QObject
{
......
......@@ -52,7 +52,6 @@ public:
wl_resource *createResource(const wl_interface *interface, quint32 version, quint32 id);
/**
* Get the wl_resource associated with the given @p id.
* @since 5.3
**/
wl_resource *getResource(quint32 id);
......@@ -102,7 +101,6 @@ public:
* If the executable path cannot be resolved an empty QString is returned.
*
* @see processId
* @since 5.6
**/
QString executablePath() const;
......@@ -120,7 +118,6 @@ public:
* This is a convenient wrapper around wl_client_destroy. The use case is in combination
* with ClientConnections created through @link Display::createClient @endlink. E.g. once
* the process for the ClientConnection exited, the ClientConnection needs to be destroyed, too.
* @since 5.5
**/
void destroy();
......
......@@ -26,7 +26,6 @@ class ContrastInterfacePrivate;
*
* @see ContrastInterface
* @see SurfaceInterface
* @since 5.5
**/
class KWAYLANDSERVER_EXPORT ContrastManagerInterface : public QObject
{
......@@ -51,7 +50,6 @@ private:
*
* @see ContrastManagerInterface
* @see SurfaceInterface
* @since 5.5
**/
class KWAYLANDSERVER_EXPORT ContrastInterface : public QObject
{
......
......@@ -82,7 +82,6 @@ public:
/**
* @returns the serial of the implicit grab which started the drag
* @since 5.6
**/
quint32 dragImplicitGrabSerial() const;
......@@ -92,7 +91,6 @@ public:
void sendClearSelection();
/**
* The event is sent when a drag-and-drop operation is ended because the implicit grab is removed.
* @since 5.6
**/
void drop();
/**
......@@ -105,12 +103,10 @@ public:
*
* @param surface The SurfaceInterface which gets motion events
* @param serial The serial to be used for enter/leave
* @since 5.6
**/
void updateDragTarget(SurfaceInterface *surface, quint32 serial);
/**
* Mark this DataDeviceInterface as being a proxy device for @p remote.
* @since 5.56
**/
void updateProxy(SurfaceInterface *remote);
......
......@@ -36,27 +36,23 @@ public:
/**
* @returns The Drag and Drop actions supported by this DataOfferInterface.
* @since 5.42
**/
DataDeviceManagerInterface::DnDActions supportedDragAndDropActions() const;
/**
* @returns The preferred Drag and Drop action of this DataOfferInterface.
* @since 5.42
**/
DataDeviceManagerInterface::DnDAction preferredDragAndDropAction() const;
/**
* This event indicates the @p action selected by the compositor after matching the
* source/destination side actions. Only one action (or none) will be offered here.
* @since 5.42
**/
void dndAction(DataDeviceManagerInterface::DnDAction action);
Q_SIGNALS:
/**
* Emitted whenever the supported or preferred Drag and Drop actions changed.
* @since 5.42
**/
void dragAndDropActionsChanged();
......
......@@ -36,7 +36,6 @@ public:
/**
* @returns The Drag and Drop actions supported by this DataSourceInterface.
* @since 5.42
**/
DataDeviceManagerInterface::DnDActions supportedDragAndDropActions() const override;
......
......@@ -109,7 +109,6 @@ public:
void createShm();
/**
* @returns All SeatInterface currently managed on the Display.
* @since 5.6
**/
QVector<SeatInterface*> seats() const;
QList<OutputDeviceInterface *> outputDevices() const;
......@@ -131,13 +130,11 @@ public:
* Wayland display prior to calling this method.
*
* @see eglDisplay
* @since 5.3
**/
void setEglDisplay(void *display);
/**
* @returns the EGLDisplay used for this Wayland display or EGL_NO_DISPLAY if not set.
* @see setEglDisplay
* @since 5.3
**/
void *eglDisplay() const;
......
......@@ -46,7 +46,6 @@ class DpmsManagerInterfacePrivate;
*
* @see Display
* @see OutputInterface
* @since 5.5
**/
class KWAYLANDSERVER_EXPORT DpmsManagerInterface : public QObject
{
......
......@@ -36,7 +36,6 @@ class FakeInputInterfacePrivate;
* way trusted clients.
*
* @see FakeInputDevice
* @since 5.4
**/
class KWAYLANDSERVER_EXPORT FakeInputInterface : public QObject
{
......@@ -61,7 +60,6 @@ private:
* @brief Represents the Resource for a org_kde_kwin_fake_input interface.
*
* @see FakeInputInterface
* @since 5.4
**/
class KWAYLANDSERVER_EXPORT FakeInputDevice : public QObject
{
......@@ -103,8 +101,6 @@ Q_SIGNALS:
void pointerMotionRequested(const QSizeF &delta);
/**
* Request an absolute pointer motion to @p pos.
*
* @since 5.54
**/
void pointerMotionAbsoluteRequested(const QPointF &pos);
/**
......@@ -121,44 +117,30 @@ Q_SIGNALS:
void pointerAxisRequested(Qt::Orientation orientation, qreal delta);
/**
* Requests a touch down at @p pos and identified by @p id.
*
* @since 5.23
**/
void touchDownRequested(quint32 id, const QPointF &pos);
/**
* Requests a touch motion by @p pos and identified by @p id.
*
* @since 5.23
**/
void touchMotionRequested(quint32 id, const QPointF &pos);
/**
* Requests a touch up identified by @p id.
*
* @since 5.23
**/
void touchUpRequested(quint32 id);
/**
* Requests a touch cancel event.
*
* @since 5.23
**/
void touchCancelRequested();
/**
* Requests a touch frame event.
*
* @since 5.23
**/
void touchFrameRequested();
/**
* Requests a keyboard key pressed for @p key.
*
* @since 5.63
**/
void keyboardKeyPressRequested(quint32 key);
/**
* Requests a keyboard key release for @p key.
*
* @since 5.63
**/
void keyboardKeyReleaseRequested(quint32 key);
......
......@@ -18,8 +18,6 @@ namespace KWaylandServer
* Server Implementation that allows one to restrict which globals are available to which clients
*
* Users of this class must implement the virtual @method allowInterface method.
*
* @since 5.FIXME
*/
class KWAYLANDSERVER_EXPORT FilteredDisplay : public Display
{
......
......@@ -34,8 +34,6 @@ class IdleInterfacePrivate;
* know whether the input devices are used, only if their surfaces have focus. With this
* interface it is possible to notice that there are input events. A server should consider
* this to decide whether it wants to provide this feature!
*
* @since 5.4
**/
class KWAYLANDSERVER_EXPORT IdleInterface : public QObject
{
......@@ -57,7 +55,6 @@ public:
* @see uninhibit
* @see isInhibited
* @see inhibitedChanged
* @since 5.41
**/
void inhibit();
......@@ -68,7 +65,6 @@ public:
* @see inhibit
* @see isInhibited
* @see inhibitedChanged
* @since 5.41
**/
void uninhibit();
......@@ -77,7 +73,6 @@ public:
* @see inhibit
* @see uninhibit
* @see inhibitedChanged
* @since 5.41
**/
bool isInhibited() const;
......@@ -86,7 +81,6 @@ public:
* This means the same action is performed as if the user interacted with
* an input device on the SeatInterface.
* Idle timeouts are resumed and the idle time gets restarted.
* @since 5.42
**/
void simulateUserActivity();
......@@ -96,7 +90,6 @@ Q_SIGNALS:
* @see inhibit
* @see uninhibit
* @see isInhibited
* @since 5.41
**/
void inhibitedChanged();
......
......@@ -21,8 +21,6 @@ class IdleInhibitManagerV1InterfacePrivate;
* The IdleInhibitorManagerInterface is used by clients to inhibit idle on a
* SurfaceInterface. Whether a SurfaceInterface inhibits idle is exposes through
* @link{SurfaceInterface::inhibitsIdle}.
*
* @since 5.41
**/
class KWAYLANDSERVER_EXPORT IdleInhibitManagerV1Interface : public QObject
{
......
......@@ -18,7 +18,6 @@ class KeyboardInterfacePrivate;
/**
* @brief Resource for the wl_keyboard interface.
*
**/
class KWAYLANDSERVER_EXPORT KeyboardInterface : public QObject
{
......@@ -51,8 +50,6 @@ public:
*
* @param charactersPerSecond The characters per second rate, value of @c 0 disables key repeating
* @param delay The delay on key press before starting repeating keys
*
* @since 5.21
**/
void setRepeatInfo(qint32 charactersPerSecond, qint32 delay);
......
......@@ -46,8 +46,6 @@ private:
* The KeyboardShortcutsInhibitManagerV1Interface allows clients to inhibit global shortcuts.
*
* KeyboardShortcutsInhibitManagerV1Interface correponds to the wayland interface zwp_keyboard_shortcuts_inhibit_manager_v1.
*
* @since 5.20
*/
class KWAYLANDSERVER_EXPORT KeyboardShortcutsInhibitManagerV1Interface : public QObject
{
......
......@@ -17,8 +17,6 @@ class KeyStateInterfacePrivate;
/**
* @brief Exposes key states to wayland clients
*
* @since 5.58
**/
class KWAYLANDSERVER_EXPORT KeyStateInterface : public QObject
{
......
......@@ -101,25 +101,21 @@ public:
/**
* Sets whether Dpms is supported for this output.
* Default is @c false.
* @since 5.5
**/
void setDpmsSupported(bool supported);
/**
* Sets the currently used dpms mode.
* Default is @c DpmsMode::On.
* @since 5.5
**/
void setDpmsMode(DpmsMode mode);
/**
* @returns all wl_resources bound for the @p client
* @since 5.27
**/
QVector<wl_resource *> clientResources(ClientConnection *client) const;
/**
* Returns @c true if the output is on; otherwise returns false.
* @since 5.20
*/
bool isEnabled() const;
......@@ -143,7 +139,6 @@ Q_SIGNALS:
/**
* Change of dpms @p mode is requested.
* A server is free to ignore this request.
* @since 5.5
**/
void dpmsModeRequested(KWaylandServer::OutputInterface::DpmsMode mode);
......
......@@ -32,8 +32,6 @@ class PlasmaShellSurfaceInterfacePrivate;
*
* A server providing this interface should think about how to restrict access to it as
* it allows to perform absolute window positioning.
*
* @since 5.4
**/
class KWAYLANDSERVER_EXPORT PlasmaShellInterface : public QObject
{
......@@ -57,8 +55,6 @@ private:
* @brief Resource for the org_kde_plasma_shell_surface interface.
*
* PlasmaShellSurfaceInterface gets created by PlasmaShellInterface.
*
* @since 5.4
**/
class KWAYLANDSERVER_EXPORT PlasmaShellSurfaceInterface : public QObject
{
......@@ -88,9 +84,9 @@ public:
Desktop, ///< The surface represents a desktop, normally stacked below all other surfaces
Panel, ///< The surface represents a panel (dock), normally stacked above normal surfaces
OnScreenDisplay, ///< The surface represents an on screen display, like a volume changed notification
Notification, ///< The surface represents a notification @since 5.24
ToolTip, ///< The surface represents a tooltip @since 5.24
CriticalNotification, ///< The surface represents a critical notification, like battery is running out @since 5.58
Notification, ///< The surface represents a notification
ToolTip, ///< The surface represents a tooltip
CriticalNotification, ///< The surface represents a critical notification, like battery is running out
};
/**
* @returns The requested role, default value is @c Role::Normal.
......@@ -114,14 +110,12 @@ public:
/**
* @returns true if this window doesn't want to be listed
* in the taskbar
* @since 5.5
**/
bool skipTaskbar() const;
/**
* @returns true if this window doesn't want to be listed
* in a window switcher
* @since 5.47
**/
bool skipSwitcher() const;
......@@ -132,7 +126,6 @@ public:
* @see showAutoHidingPanel
* @see panelAutoHideHideRequested
* @see panelAutoHideShowRequested
* @since 5.28
**/
void hideAutoHidingPanel();
......@@ -152,14 +145,12 @@ public:
* By default some PlasmaShell roles do not get focus, but the PlasmaShellSurfaceInterface can
* request that it wants to have focus. The compositor can use this information to
* pass focus to the surface.
* @since 5.28
**/
//TODO KF6 rename to something generic
bool panelTakesFocus() const;
/**
* @returns The PlasmaShellSurfaceInterface for the @p native resource.
* @since 5.5
**/
static PlasmaShellSurfaceInterface *get(wl_resource *native);
......@@ -197,7 +188,6 @@ Q_SIGNALS:
* @see hideAutoHidingPanel
* @see showAutoHidingPanel
* @see panelAutoHideShowRequested
* @since 5.28
**/
void panelAutoHideHideRequested();
......@@ -210,14 +200,12 @@ Q_SIGNALS:
* @see hideAutoHidingPanel
* @see showAutoHidingPanel
* @see panelAutoHideHideRequested
* @since 5.28
**/
void panelAutoHideShowRequested();
/*
* Emitted when panelTakesFocus changes
* @see panelTakesFocus
* @since 5.66
*/
void panelTakesFocusChanged();
......
......@@ -21,7 +21,6 @@ class PlasmaVirtualDesktopManagementInterfacePrivate;
* @short Wrapper for the org_kde_plasma_virtual_desktop_management interface.
*
* This class provides a convenient wrapper for the org_kde_plasma_virtual_desktop_management interface.
* @since 5.52
*/
class KWAYLANDSERVER_EXPORT PlasmaVirtualDesktopManagementInterface : public QObject
{
......@@ -33,7 +32,6 @@ public:
/**
* Sets how many rows the virtual desktops should be laid into
* @since 5.55
*/
void setRows(quint32 rows);
......
......@@ -44,20 +44,17 @@ public:
* Associate a PlasmaVirtualDesktopManagementInterface to this window management.
* It's necessary to associate one in orderto use the plasma virtual desktop features
* of PlasmaWindowInterface, as a window must know what are the deasktops available
* @since 5.48
*/
void setPlasmaVirtualDesktopManagementInterface(PlasmaVirtualDesktopManagementInterface *manager);
/**
* @returns the PlasmaVirtualDesktopManagementInterface associated to this PlasmaWindowManagementInterface
* @since 5.48
*/
PlasmaVirtualDesktopManagementInterface *plasmaVirtualDesktopManagementInterface() const;
/**
* Associate stacking order to this window management
* @since 5.70
*/
void setStackingOrder(const QVector<quint32> &stackingOrder);
......@@ -108,25 +105,12 @@ public:
KWAYLANDSERVER_DEPRECATED_VERSION(5, 28, "Use PlasmaWindowManagementInterface::setIcon(const QIcon&)")
void setThemedIconName(const QString &iconName);
#endif
/**
* @since 5.22
*/
void setShadeable(bool set);
/**
* @since 5.22
*/
void setShaded(bool set);
/**
* @since 5.22
*/
void setMovable(bool set);
/**
* @since 5.22
*/
void setResizable(bool set);
/**
* FIXME: still relevant with new desktops?
* @since 5.22
*/
void setVirtualDesktopChangeable(bool set);
......@@ -141,7 +125,6 @@ public:
/**
* @returns Geometries of the taskbar entries, indicized by the
* surface of the panels
* @since 5.5
*/
QHash<SurfaceInterface*, QRect> minimizedGeometries() const;
......@@ -149,7 +132,6 @@ public:
* Sets this PlasmaWindowInterface as a transient window to @p parentWindow.
* If @p parentWindow is @c nullptr, the PlasmaWindowInterface is a toplevel
* window and does not have a parent window.
* @since 5.24
**/
void setParentWindow(PlasmaWindowInterface *parentWindow);
......@@ -157,7 +139,6 @@ public:
* Sets the window @p geometry of this PlasmaWindow.
*
* @param geometry The geometry in absolute coordinates
* @since 5.25
**/
void setGeometry(const QRect &geometry);
......@@ -170,7 +151,6 @@ public:
* into which the icon will be serialized.
*
* @param icon The new icon
* @since 5.28
**/
void setIcon(const QIcon &icon);
......@@ -178,56 +158,38 @@ public:
* Adds a new desktop to this window: a window can be on
* an arbitrary subset of virtual desktops.
* If it's on none it will be considered on all desktops.
*
* @since 5.48
*/
void addPlasmaVirtualDesktop(const QString &id);
/**
* Removes a visrtual desktop from a window
*
* @since 5.48
*/
void removePlasmaVirtualDesktop(const QString &id);
/**
* The ids of all the desktops currently associated with this window.
* When a desktop is deleted it will be automatically removed from this list
*
* @since 5.48
*/
QStringList plasmaVirtualDesktops() const;
/**
* Set the application menu D-BUS service name and object path for the window.
*
* @since 5.69
*/
void setApplicationMenuPaths(const QString &serviceName, const QString &objectPath);
/**
* Return the window internal id
*
* @since 5.70
*/
quint32 internalId() const;
/**
* @return a unique string that identifies this window
*
* @since Plasma 5.20
*/
QByteArray uuid() const;
Q_SIGNALS:
void closeRequested();
/**
* @since 5.22
*/
void moveRequested();
/**
* @since 5.22
*/
void resizeRequested();
#if KWAYLANDSERVER_ENABLE_DEPRECATED_SINCE(5, 52)
/**
......@@ -250,32 +212,18 @@ Q_SIGNALS:
void skipTaskbarRequested(bool set);
void skipSwitcherRequested(bool set);
QRect minimizedGeometriesChanged();
/**
* @since 5.22
*/
void shadeableRequested(bool set);
/**
* @since 5.22
*/
void shadedRequested(bool set);
/**
* @since 5.22
*/
void movableRequested(bool set);
/**
* @since 5.22
*/
void resizableRequested(bool set);
/**
* FIXME: still relevant with new virtual desktops?
* @since 5.22
*/
void virtualDesktopChangeableRequested(bool set);
/**
* Emitted when the client wishes this window to enter in a new virtual desktop.
* The server will decide whether to consent this request
* @since 5.52
*/
void enterPlasmaVirtualDesktopRequested(const QString &desktop);
......@@ -283,14 +231,12 @@ Q_SIGNALS:
* Emitted when the client wishes this window to enter in
* a new virtual desktop to be created for it.
* The server will decide whether to consent this request
* @since 5.52
*/
void enterNewPlasmaVirtualDesktopRequested();