Commit 66a8ffd0 authored by Vlad Zahorodnii's avatar Vlad Zahorodnii
Browse files

Use common doxygen comment terminator style

In plasma code, it's more common to see `/** ... */` doxygen comments
rather than `/** ... **/`.

This change fixes up doxygen comment terminators to prevent inconsistency
issues.
parent 390d99e8
Pipeline #55340 passed with stage
in 7 minutes and 13 seconds
......@@ -41,22 +41,22 @@ public:
/**
* @returns The Drag and Drop actions supported by this DataSourceInterface.
**/
*/
virtual DataDeviceManagerInterface::DnDActions supportedDragAndDropActions() const {
return {};
};
/**
* The user performed the drop action during a drag and drop operation.
**/
*/
virtual void dropPerformed() {};
/**
* The drop destination finished interoperating with this data source.
**/
*/
virtual void dndFinished() {};
/**
* 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.
**/
*/
virtual void dndAction(DataDeviceManagerInterface::DnDAction action) {
Q_UNUSED(action);
};
......
......@@ -42,7 +42,7 @@ public:
Q_SIGNALS:
/**
* Emitted whenever a new AppmenuInterface is created.
**/
*/
void appMenuCreated(KWaylandServer::AppMenuInterface*);
private:
......@@ -76,7 +76,7 @@ public:
/**
* @returns The SurfaceInterface this AppmenuInterface references.
**/
*/
SurfaceInterface *surface() const;
Q_SIGNALS:
......
......@@ -27,7 +27,7 @@ class BlurInterfacePrivate;
*
* @see BlurInterface
* @see SurfaceInterface
**/
*/
class KWAYLANDSERVER_EXPORT BlurManagerInterface : public QObject
{
Q_OBJECT
......@@ -52,7 +52,7 @@ private:
*
* @see BlurManagerInterface
* @see SurfaceInterface
**/
*/
class KWAYLANDSERVER_EXPORT BlurInterface : public QObject
{
Q_OBJECT
......@@ -61,7 +61,7 @@ public:
/**
* @returns The region or the SurfaceInterface which should be blurred, null Region implies complete surface.
**/
*/
QRegion region();
private:
......
......@@ -44,7 +44,7 @@ class LinuxDmabufBuffer;
*
* @see Display
* @see SurfaceInterace
**/
*/
class KWAYLANDSERVER_EXPORT BufferInterface : public QObject
{
Q_OBJECT
......@@ -60,7 +60,7 @@ public:
*
* @see unref
* @see isReferenced
**/
*/
void ref();
/**
* Unreference the BufferInterface.
......@@ -70,19 +70,19 @@ public:
*
* @see ref
* @see isReferenced
**/
*/
void unref();
/**
* @returns whether the BufferInterface is currently referenced
*
* @see ref
* @see unref
**/
*/
bool isReferenced() const;
/**
* @returns The native wl_shm_buffer if the BufferInterface represents a shared memory buffer, otherwise @c nullptr.
**/
*/
wl_shm_buffer *shmBuffer();
/**
* Returns a pointer to the LinuxDmabufBuffer when the buffer is a dmabuf buffer, and nullptr otherwise.
......@@ -90,7 +90,7 @@ public:
LinuxDmabufBuffer *linuxDmabufBuffer();
/**
* @returns the native wl_resource wrapped by this BufferInterface.
**/
*/
wl_resource *resource() const;
/**
......@@ -112,7 +112,7 @@ public:
* write to the returned QImage. The image is a read-only buffer. If there is need to modify
* the image, perform a deep copy.
*
**/
*/
QImage data();
/**
......@@ -131,13 +131,13 @@ public:
* provide the proper size.
* @see setSize
* @see Display::setEglDisplay
**/
*/
QSize size() const;
/**
* Sets the @p size for non shared memory buffers.
* @see size
* @see sizeChanged
**/
*/
void setSize(const QSize &size);
/**
......@@ -150,7 +150,7 @@ public:
*
* If the format cannot be queried the default value (@c false) is returned.
*
**/
*/
bool hasAlphaChannel() const;
static BufferInterface *get(Display *display, wl_resource *r);
......@@ -159,7 +159,7 @@ Q_SIGNALS:
void aboutToBeDestroyed(KWaylandServer::BufferInterface*);
/**
* Emitted when the size of the Buffer changes.
**/
*/
void sizeChanged();
private:
......
......@@ -28,7 +28,7 @@ class Display;
* @link Display::clientConnected @endlink will be emitted.
*
* @see Display
**/
*/
class KWAYLANDSERVER_EXPORT ClientConnection : public QObject
{
Q_OBJECT
......@@ -37,7 +37,7 @@ public:
/**
* Flushes the connection to this client. Ensures that all events are pushed to the client.
**/
*/
void flush();
/**
* Creates a new wl_resource for the provided @p interface.
......@@ -48,20 +48,20 @@ public:
* @param version
* @param id
* @returns the created native wl_resource
**/
*/
wl_resource *createResource(const wl_interface *interface, quint32 version, quint32 id);
/**
* Get the wl_resource associated with the given @p id.
**/
*/
wl_resource *getResource(quint32 id);
/**
* @returns the native wl_client this ClientConnection represents.
**/
*/
wl_client *client() const;
/**
* @returns The Display this ClientConnection is connected to
**/
*/
Display *display() const;
/**
......@@ -71,7 +71,7 @@ public:
* the pid will be identical to the process running the KWaylandServer::Display.
*
* @returns The pid of the connection.
**/
*/
pid_t processId() const;
/**
* The uid of the ClientConnection endpoint.
......@@ -80,7 +80,7 @@ public:
* the uid will be identical to the process running the KWaylandServer::Display.
*
* @returns The uid of the connection.
**/
*/
uid_t userId() const;
/**
* The gid of the ClientConnection endpoint.
......@@ -89,7 +89,7 @@ public:
* the gid will be identical to the process running the KWaylandServer::Display.
*
* @returns The gid of the connection.
**/
*/
gid_t groupId() const;
/**
......@@ -101,16 +101,16 @@ public:
* If the executable path cannot be resolved an empty QString is returned.
*
* @see processId
**/
*/
QString executablePath() const;
/**
* Cast operator the native wl_client this ClientConnection represents.
**/
*/
operator wl_client*();
/**
* Cast operator the native wl_client this ClientConnection represents.
**/
*/
operator wl_client*() const;
/**
......@@ -118,13 +118,13 @@ 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.
**/
*/
void destroy();
Q_SIGNALS:
/**
* Signal emitted when the ClientConnection got disconnected from the server.
**/
*/
void disconnected(KWaylandServer::ClientConnection*);
private:
......
......@@ -26,7 +26,7 @@ class ContrastInterfacePrivate;
*
* @see ContrastInterface
* @see SurfaceInterface
**/
*/
class KWAYLANDSERVER_EXPORT ContrastManagerInterface : public QObject
{
Q_OBJECT
......@@ -50,7 +50,7 @@ private:
*
* @see ContrastManagerInterface
* @see SurfaceInterface
**/
*/
class KWAYLANDSERVER_EXPORT ContrastInterface : public QObject
{
Q_OBJECT
......
......@@ -64,7 +64,7 @@ private:
*
* @see SeatInterface
* @see DataSourceInterface
**/
*/
class KWAYLANDSERVER_EXPORT DataDeviceInterface : public QObject
{
Q_OBJECT
......@@ -82,7 +82,7 @@ public:
/**
* @returns the serial of the implicit grab which started the drag
**/
*/
quint32 dragImplicitGrabSerial() const;
DataSourceInterface *selection() const;
......@@ -91,7 +91,7 @@ public:
void sendClearSelection();
/**
* The event is sent when a drag-and-drop operation is ended because the implicit grab is removed.
**/
*/
void drop();
/**
* Updates the SurfaceInterface to which drag motion events are sent.
......@@ -103,11 +103,11 @@ public:
*
* @param surface The SurfaceInterface which gets motion events
* @param serial The serial to be used for enter/leave
**/
*/
void updateDragTarget(SurfaceInterface *surface, quint32 serial);
/**
* Mark this DataDeviceInterface as being a proxy device for @p remote.
**/
*/
void updateProxy(SurfaceInterface *remote);
wl_client *client();
......
......@@ -21,7 +21,7 @@ class DataDeviceManagerInterfacePrivate;
/**
* @brief Represents the Global for wl_data_device_manager interface.
*
**/
*/
class KWAYLANDSERVER_EXPORT DataDeviceManagerInterface : public QObject
{
Q_OBJECT
......@@ -32,7 +32,7 @@ public:
/**
* Drag and Drop actions supported by the DataSourceInterface.
**/
*/
enum class DnDAction {
None = 0,
Copy = 1 << 0,
......
......@@ -23,7 +23,7 @@ class DataOfferInterfacePrivate;
/**
* @brief Represents the Resource for the wl_data_offer interface.
*
**/
*/
class KWAYLANDSERVER_EXPORT DataOfferInterface : public QObject
{
Q_OBJECT
......@@ -36,24 +36,24 @@ public:
/**
* @returns The Drag and Drop actions supported by this DataOfferInterface.
**/
*/
DataDeviceManagerInterface::DnDActions supportedDragAndDropActions() const;
/**
* @returns The preferred Drag and Drop action of this DataOfferInterface.
**/
*/
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.
**/
*/
void dndAction(DataDeviceManagerInterface::DnDAction action);
Q_SIGNALS:
/**
* Emitted whenever the supported or preferred Drag and Drop actions changed.
**/
*/
void dragAndDropActionsChanged();
private:
......
......@@ -19,7 +19,7 @@ class DataSourceInterfacePrivate;
/**
* @brief Represents the Resource for the wl_data_source interface.
**/
*/
class KWAYLANDSERVER_EXPORT DataSourceInterface : public AbstractDataSource
{
Q_OBJECT
......@@ -36,7 +36,7 @@ public:
/**
* @returns The Drag and Drop actions supported by this DataSourceInterface.
**/
*/
DataDeviceManagerInterface::DnDActions supportedDragAndDropActions() const override;
void dropPerformed() override;
......
......@@ -31,7 +31,7 @@ namespace KWaylandServer
* Qt style API.
*
* @see Display
**/
*/
class ClientConnection;
class DisplayPrivate;
......@@ -43,7 +43,7 @@ class SeatInterface;
* @brief Class holding the Wayland server display loop.
*
* @todo Improve documentation
**/
*/
class KWAYLANDSERVER_EXPORT Display : public QObject
{
Q_OBJECT
......@@ -99,7 +99,7 @@ public:
*
* @param fd The file descriptor for the socket to the client
* @returns The new ClientConnection or @c null on failure.
**/
*/
ClientConnection *createClient(int fd);
operator wl_display*();
......@@ -109,7 +109,7 @@ public:
void createShm();
/**
* @returns All SeatInterface currently managed on the Display.
**/
*/
QVector<SeatInterface*> seats() const;
QList<OutputDeviceInterface *> outputDevices() const;
QList<OutputInterface *> outputs() const;
......@@ -119,7 +119,7 @@ public:
* If there is no ClientConnection yet for the given @p client, it will be created.
* @param client The native client for which the ClientConnection is retrieved
* @return The ClientConnection for the given native client
**/
*/
ClientConnection *getConnection(wl_client *client);
QVector<ClientConnection*> connections() const;
......@@ -130,12 +130,12 @@ public:
* Wayland display prior to calling this method.
*
* @see eglDisplay
**/
*/
void setEglDisplay(void *display);
/**
* @returns the EGLDisplay used for this Wayland display or EGL_NO_DISPLAY if not set.
* @see setEglDisplay
**/
*/
void *eglDisplay() const;
private Q_SLOTS:
......
......@@ -46,7 +46,7 @@ class DpmsManagerInterfacePrivate;
*
* @see Display
* @see OutputInterface
**/
*/
class KWAYLANDSERVER_EXPORT DpmsManagerInterface : public QObject
{
Q_OBJECT
......
......@@ -36,7 +36,7 @@ class FakeInputInterfacePrivate;
* way trusted clients.
*
* @see FakeInputDevice
**/
*/
class KWAYLANDSERVER_EXPORT FakeInputInterface : public QObject
{
Q_OBJECT
......@@ -49,7 +49,7 @@ Q_SIGNALS:
/**
* Signal emitted whenever a client bound the fake input @p device.
* @param device The created FakeInputDevice
**/
*/
void deviceCreated(KWaylandServer::FakeInputDevice *device);
private:
......@@ -60,7 +60,7 @@ private:
* @brief Represents the Resource for a org_kde_kwin_fake_input interface.
*
* @see FakeInputInterface
**/
*/
class KWAYLANDSERVER_EXPORT FakeInputDevice : public QObject
{
Q_OBJECT
......@@ -68,7 +68,7 @@ public:
~FakeInputDevice() override;
/**
* @returns the native wl_resource.
**/
*/
wl_resource *resource();
/**
......@@ -76,11 +76,11 @@ public:
* accepted, for @c false events are no longer accepted.
*
* @param authenticated Whether the FakeInputDevice should be considered authenticated
**/
*/
void setAuthentication(bool authenticated);
/**
* @returns whether the FakeInputDevice is authenticated and allowed to send events, default is @c false.
**/
*/
bool isAuthenticated() const;
Q_SIGNALS:
......@@ -93,55 +93,55 @@ Q_SIGNALS:
*
* @param application A textual description of the application
* @param reason A textual description of the reason why the application wants to send fake input events
**/
*/
void authenticationRequested(const QString &application, const QString &reason);
/**
* Request a pointer motion by @p delta.
**/
*/
void pointerMotionRequested(const QSizeF &delta);
/**
* Request an absolute pointer motion to @p pos.
**/
*/
void pointerMotionAbsoluteRequested(const QPointF &pos);
/**
* Requests a pointer button pressed for @p button.
**/
*/
void pointerButtonPressRequested(quint32 button);
/**
* Requests a pointer button release for @p button.
**/
*/
void pointerButtonReleaseRequested(quint32 button);
/**
* Requests a pointer axis for the given @p orientation by @p delta.
**/
*/
void pointerAxisRequested(Qt::Orientation orientation, qreal delta);
/**
* Requests a touch down at @p pos and identified by @p id.
**/
*/
void touchDownRequested(quint32 id, const QPointF &pos);
/**
* Requests a touch motion by @p pos and identified by @p id.
**/
*/
void touchMotionRequested(quint32 id, const QPointF &pos);
/**
* Requests a touch up identified by @p id.
**/
*/
void touchUpRequested(quint32 id);
/**
* Requests a touch cancel event.
**/
*/
void touchCancelRequested();
/**
* Requests a touch frame event.
**/
*/
void touchFrameRequested();
/**
* Requests a keyboard key pressed for @p key.
**/
*/
void keyboardKeyPressRequested(quint32 key);
/**
* Requests a keyboard key release for @p key.
**/
*/
void keyboardKeyReleaseRequested(quint32 key);
private:
......
......@@ -39,7 +39,7 @@ class Display;
*
* @see Display
*
**/
*/
class KWAYLANDSERVER_EXPORT Global : public QObject
{
Q_OBJECT
......@@ -48,15 +48,15 @@ public:
/**
* Creates the global by creating a native wl_global and by that announcing it
* to the clients.
**/
*/
void create();
/**
* Destroys the low level wl_global. Afterwards the Global is no longer shown to clients.
**/
*/
void destroy();
/**
* @returns whether the Global got created
**/
*/
bool isValid() const;
/**
......@@ -66,11 +66,11 @@ public:
/**
* Cast operator to the native wl_global this Global represents.
**/
*/
operator wl_global*();
/**
* Cast operator to the native wl_global this Global represents.
**/
*/
operator wl_global*() const;
Q_SIGNALS:
......
......@@ -34,7 +34,7 @@ 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!
**/
*/
class KWAYLANDSERVER_EXPORT IdleInterface : public QObject
{
Q_OBJECT
......@@ -55,7 +55,7 @@ public:
* @see uninhibit
* @see isInhibited
* @see inhibitedChanged
**/
*/
void inhibit();
/**
......@@ -65,7 +65,7 @@ public:
* @see inhibit
* @see isInhibited
* @see inhibitedChanged