diff options
Diffstat (limited to 'src/compositor/compositor_api')
12 files changed, 142 insertions, 126 deletions
diff --git a/src/compositor/compositor_api/qwaylandbufferref.cpp b/src/compositor/compositor_api/qwaylandbufferref.cpp index a00bbcdd9..7cc17fcbe 100644 --- a/src/compositor/compositor_api/qwaylandbufferref.cpp +++ b/src/compositor/compositor_api/qwaylandbufferref.cpp @@ -56,7 +56,7 @@ public: * \class QWaylandBufferRef * \inmodule QtWaylandCompositor * \preliminary - * \brief A class which holds a reference to a surface buffer + * \brief The QWaylandBufferRef class holds the reference to a surface buffer * * This class can be used to reference a surface buffer. As long as a reference * to the buffer exists, it is owned by the compositor and the client cannot modify it. diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp index 0b21bcd63..23c3745d7 100644 --- a/src/compositor/compositor_api/qwaylandclient.cpp +++ b/src/compositor/compositor_api/qwaylandclient.cpp @@ -88,7 +88,7 @@ public: * \qmltype WaylandClient * \inqmlmodule QtWayland.Compositor * \preliminary - * \brief A client connecting to the WaylandCompositor. + * \brief Represents a client connecting to the WaylandCompositor. * * This type represents a client connecting to the compositor using the Wayland protocol. * It corresponds to the Wayland interface wl_client. @@ -98,7 +98,7 @@ public: * \class QWaylandClient * \inmodule QtWaylandCompositor * \preliminary - * \brief A client connecting to the QWaylandCompositor. + * \brief The QWaylandClient class represents a client connecting to the QWaylandCompositor. * * This class corresponds to a client connecting to the compositor using the Wayland protocol. * It corresponds to the Wayland interface wl_client. @@ -199,6 +199,7 @@ wl_client *QWaylandClient::client() const /*! * \property QWaylandClient::userId + * \readonly * * This property holds the user id of this QWaylandClient. */ @@ -211,6 +212,7 @@ qint64 QWaylandClient::userId() const /*! * \qmlproperty int QtWaylandCompositor::WaylandClient::groupId + * \readonly * * This property holds the group id of this WaylandClient. */ @@ -229,6 +231,7 @@ qint64 QWaylandClient::groupId() const /*! * \qmlproperty int QtWaylandCompositor::WaylandClient::processId + * \readonly * * This property holds the process id of this WaylandClient. */ diff --git a/src/compositor/compositor_api/qwaylandcompositor.cpp b/src/compositor/compositor_api/qwaylandcompositor.cpp index 0feba9857..391b39416 100644 --- a/src/compositor/compositor_api/qwaylandcompositor.cpp +++ b/src/compositor/compositor_api/qwaylandcompositor.cpp @@ -408,7 +408,7 @@ void QWaylandCompositorPrivate::loadServerBufferIntegration() \qmltype WaylandCompositor \inqmlmodule QtWayland.Compositor \preliminary - \brief Type managing the Wayland display server. + \brief Manages the Wayland display server. The WaylandCompositor manages the connections to the clients, as well as the different \l{WaylandOutput}{outputs} and \l{QWaylandSeat}{seats}. @@ -427,7 +427,7 @@ void QWaylandCompositorPrivate::loadServerBufferIntegration() \class QWaylandCompositor \inmodule QtWaylandCompositor \preliminary - \brief Class managing the Wayland display server. + \brief The QWaylandCompositor class manages the Wayland display server. The QWaylandCompositor manages the connections to the clients, as well as the different \l{QWaylandOutput}{outputs} and \l{QWaylandSeat}{seats}. @@ -486,9 +486,8 @@ bool QWaylandCompositor::isCreated() const * clients. It must be set before the component is completed. * * If the socketName is empty (the default), the contents of the start argument - * --wayland-socket-name is used instead. If this is not set, then the compositor - * will try to find a socket name automatically, which in the default case will - * be "wayland-0". + * \c --wayland-socket-name are used instead. If the argument is not set, the + * compositor tries to find a socket name, which is \c{wayland-0} by default. */ /*! @@ -498,9 +497,8 @@ bool QWaylandCompositor::isCreated() const * clients. This must be set before the QWaylandCompositor is \l{create()}{created}. * * If the socketName is empty (the default), the contents of the start argument - * --wayland-socket-name is used instead. If this is not set, then the compositor - * will try to find a socket name automatically, which in the default case will - * be "wayland-0". + * \c --wayland-socket-name are used instead. If the argument is not set, the + * compositor tries to find a socket name, which is \c{wayland-0} by default. */ void QWaylandCompositor::setSocketName(const QByteArray &name) { @@ -844,11 +842,11 @@ void QWaylandCompositor::setUseHardwareIntegrationExtension(bool use) /*! * Grab the surface content from the given \a buffer. * The default implementation requires a OpenGL context to be bound to the current thread - * to work. If this is not possible reimplement this function in your compositor subclass + * to work. If this is not possible, reimplement this function in your compositor subclass * to implement custom logic. * The default implementation only grabs shared memory and OpenGL buffers, reimplement this in your * compositor subclass to handle more buffer types. - * You should not call this manually, but rather use QWaylandSurfaceGrabber (\a grabber). + * \note You should not call this manually, but rather use QWaylandSurfaceGrabber (\a grabber). */ void QWaylandCompositor::grabSurface(QWaylandSurfaceGrabber *grabber, const QWaylandBufferRef &buffer) { diff --git a/src/compositor/compositor_api/qwaylandkeyboard.cpp b/src/compositor/compositor_api/qwaylandkeyboard.cpp index d29b9d947..42349fb24 100644 --- a/src/compositor/compositor_api/qwaylandkeyboard.cpp +++ b/src/compositor/compositor_api/qwaylandkeyboard.cpp @@ -382,7 +382,7 @@ void QWaylandKeyboardPrivate::sendRepeatInfo() * \class QWaylandKeyboard * \inmodule QtWaylandCompositor * \preliminary - * \brief The QWaylandKeyboard class provides access to a keyboard device. + * \brief The QWaylandKeyboard class represents a keyboard device. * * This class provides access to the keyboard device in a QWaylandSeat. It corresponds to * the Wayland interface wl_keyboard. diff --git a/src/compositor/compositor_api/qwaylandoutput.cpp b/src/compositor/compositor_api/qwaylandoutput.cpp index 9e66b9a44..c34080b36 100644 --- a/src/compositor/compositor_api/qwaylandoutput.cpp +++ b/src/compositor/compositor_api/qwaylandoutput.cpp @@ -190,32 +190,32 @@ QWaylandOutput::QWaylandOutput() \qmltype WaylandOutput \inqmlmodule QtWayland.Compositor \preliminary - \brief Type providing access to a displayable area managed by the compositor. + \brief Provides access to a displayable area managed by the compositor. - The WaylandOutput manages a rectangular part of the compositor's geometry that - can be used for displaying client content. This could, for instance, be a screen - managed by the WaylandCompositor. + The WaylandOutput manages a rectangular area within bounds of the compositor's + geometry, to use it for displaying client content. This could, for instance, be + a screen managed by the WaylandCompositor. - The type corresponds to the wl_output interface in the Wayland protocol. + The type corresponds to the \c wl_output interface in the Wayland protocol. */ /*! \class QWaylandOutput \inmodule QtWaylandCompositor \preliminary - \brief The QWaylandOutput class provides access to a displayable area managed by the compositor. + \brief The QWaylandOutput class represents a displayable area managed by the compositor. - The QWaylandOutput manages a rectangular part of the compositor's geometry that - can be used for displaying client content. This could, for instance, be a screen - managed by the QWaylandCompositor. + The QWaylandOutput manages a rectangular area within bounds of the compositor's + geometry, to use it for displaying client content. This could, for instance, be + a screen managed by the WaylandCompositor. - The class corresponds to the wl_output interface in the Wayland protocol. + The class corresponds to the \c wl_output interface in the Wayland protocol. */ /*! * Constructs a QWaylandOutput in \a compositor and with the specified \a window. The - * \l{QWaylandCompositor::create()}{create()} function must have been called on the - * \a compositor before a QWaylandOutput is constructed for it. + * \l{QWaylandCompositor::create()}{create()} function must be called on the + * \a compositor before constructing a QWaylandOutput for it. * * The QWaylandOutput object is initialized later, in reaction to an event. * At this point it is added as an output for the \a compositor. If it is the @@ -307,8 +307,10 @@ void QWaylandOutput::update() /*! * \qmlproperty object QtWaylandCompositor::WaylandOutput::compositor * - * This property holds the compositor displaying content on this QWaylandOutput. - * This property can only be set once, before the WaylandOutput component is completed. + * This property holds the compositor displaying content on this WaylandOutput. + * + * \note This property can be set only once, before the WaylandOutput component + * is completed. */ /*! @@ -643,14 +645,14 @@ void QWaylandOutput::setSubpixel(const Subpixel &subpixel) * * This enum type is used to specify the orientation of a QWaylandOutput. * - * \value TransformNormal The QWaylandOutput orientation is normal. - * \value Transform90 The QWaylandOutput is rotated 90 degrees. - * \value Transform180 The QWaylandOutput is rotated 180 degrees. - * \value Transform270 The QWaylandOutput is rotated 270 degrees. - * \value TransformFlipped The QWaylandOutput is mirrored. - * \value TransformFlipped90 The QWaylandOutput is mirrored, and rotated 90 degrees. - * \value TransformFlipped180 The QWaylandOutput is mirrored, and rotated 180 degrees. - * \value TransformFlipped270 The QWaylandOutput is mirrored, and rotated 270 degrees. + * \value TransformNormal The orientation is normal. + * \value Transform90 The orientation is rotated 90 degrees. + * \value Transform180 The orientation is rotated 180 degrees. + * \value Transform270 The orientation is rotated 270 degrees. + * \value TransformFlipped The orientation is mirrored. + * \value TransformFlipped90 The orientation is mirrored, and rotated 90 degrees. + * \value TransformFlipped180 The orientation is mirrored, and rotated 180 degrees. + * \value TransformFlipped270 The orientation is mirrored, and rotated 270 degrees. * * \sa QWaylandOutput::transform */ @@ -662,14 +664,14 @@ void QWaylandOutput::setSubpixel(const Subpixel &subpixel) * to compensate for the orientation of the QWaylandOutput. * * \list - * \li WaylandOutput.TransformNormal The QWaylandOutput orientation is normal. - * \li WaylandOutput.Transform90 The QWaylandOutput is rotated 90 degrees. - * \li WaylandOutput.Transform180 The QWaylandOutput is rotated 180 degrees. - * \li WaylandOutput.Transform270 The QWaylandOutput is rotated 270 degrees. - * \li WaylandOutput.TransformFlipped The QWaylandOutput is mirrored. - * \li WaylandOutput.TransformFlipped90 The QWaylandOutput is mirrored, then rotated 90 degrees. - * \li WaylandOutput.TransformFlipped180 The QWaylandOutput is mirrored, then rotated 180 degrees. - * \li WaylandOutput.TransformFlipped270 The QWaylandOutput is mirrored, then rotated 270 degrees. + * \li WaylandOutput.TransformNormal The orientation is normal. + * \li WaylandOutput.Transform90 The orientation is rotated 90 degrees. + * \li WaylandOutput.Transform180 The orientation is rotated 180 degrees. + * \li WaylandOutput.Transform270 The orientation is rotated 270 degrees. + * \li WaylandOutput.TransformFlipped The orientation is mirrored. + * \li WaylandOutput.TransformFlipped90 The orientation is mirrored, then rotated 90 degrees. + * \li WaylandOutput.TransformFlipped180 The orientation is mirrored, then rotated 180 degrees. + * \li WaylandOutput.TransformFlipped270 The orientation is mirrored, then rotated 270 degrees. * \endlist * * The default is WaylandOutput.TransformNormal. @@ -705,7 +707,7 @@ void QWaylandOutput::setTransform(const Transform &transform) * \qmlproperty int QtWaylandCompositor::WaylandOutput::scaleFactor * * This property holds the factor by which the WaylandCompositor scales surface buffers - * before they are displayed. This is used on high density output devices where unscaled content + * before they are displayed. It is used on high density output devices where unscaled content * would be too small to be practical. The client can in turn set the scale factor of its * buffer to match the output if it prefers to provide high resolution content that is * suitable for the output device. @@ -753,7 +755,7 @@ void QWaylandOutput::setScaleFactor(int scale) * This property controls whether the size of the WaylandOutput matches the * size of its window. * - * The default is true if this WaylandOutput has a window. + * The default is \c true if this WaylandOutput has a window. */ /*! @@ -762,7 +764,7 @@ void QWaylandOutput::setScaleFactor(int scale) * This property controls whether the size of the QWaylandOutput matches the * size of its window. * - * The default is true if this QWaylandOutput has a window. + * The default is \c true if this QWaylandOutput has a window. */ bool QWaylandOutput::sizeFollowsWindow() const { @@ -794,8 +796,10 @@ void QWaylandOutput::setSizeFollowsWindow(bool follow) /*! * \qmlproperty object QtWaylandCompositor::WaylandOutput::window * - * This property holds the Window for this WaylandOutput. This property can only be set once, - * before the WaylandOutput component is completed. + * This property holds the Window for this WaylandOutput. + * + * \note This property can be set only once, before the WaylandOutput + * component is completed. */ /*! @@ -822,7 +826,7 @@ void QWaylandOutput::setWindow(QWindow *window) } /*! - * Tells the QWaylandOutput that a frame has started. + * Informs QWaylandOutput that a frame has started. */ void QWaylandOutput::frameStarted() { @@ -878,7 +882,7 @@ void QWaylandOutput::surfaceLeave(QWaylandSurface *surface) } /*! - * This functions sets the width of this QWaylandOutput to \a newWidth. + * Sets the width of this QWaylandOutput to \a newWidth. * * \sa setHeight, QWaylandOutput::geometry */ @@ -894,7 +898,7 @@ void QWaylandOutput::setWidth(int newWidth) } /*! - * This functions sets the height of this QWaylandOutput to \a newHeight. + * Sets the height of this QWaylandOutput to \a newHeight. * * \sa setWidth, QWaylandOutput::geometry */ diff --git a/src/compositor/compositor_api/qwaylandpointer.cpp b/src/compositor/compositor_api/qwaylandpointer.cpp index 2ca8c51a2..742987c8b 100644 --- a/src/compositor/compositor_api/qwaylandpointer.cpp +++ b/src/compositor/compositor_api/qwaylandpointer.cpp @@ -95,7 +95,7 @@ void QWaylandPointerPrivate::pointer_set_cursor(wl_pointer::Resource *resource, * \class QWaylandPointer * \inmodule QtWaylandCompositor * \preliminary - * \brief The QWaylandPointer class provides access to a pointer device. + * \brief The QWaylandPointer class represents a pointer device. * * This class provides access to the pointer device in a QWaylandSeat. It corresponds to * the Wayland interface wl_pointer. diff --git a/src/compositor/compositor_api/qwaylandquickcompositor.cpp b/src/compositor/compositor_api/qwaylandquickcompositor.cpp index ae34cddf9..07ea381b4 100644 --- a/src/compositor/compositor_api/qwaylandquickcompositor.cpp +++ b/src/compositor/compositor_api/qwaylandquickcompositor.cpp @@ -79,8 +79,8 @@ QWaylandQuickCompositor::QWaylandQuickCompositor(QObject *parent) * any Wayland extension the compositor should support, instantiate its component, * and add it to the list of extensions. * - * For instance, the following code would allow the clients to request wl shell surfaces - * in the compositor using the wl_shell interface. + * For instance, the following code would allow the clients to request \c wl_shell + * surfaces in the compositor using the \c wl_shell interface. * * \code * import QtWayland.Compositor 1.0 diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp index 6ea44feac..08eefffa0 100644 --- a/src/compositor/compositor_api/qwaylandquickitem.cpp +++ b/src/compositor/compositor_api/qwaylandquickitem.cpp @@ -336,10 +336,10 @@ private: * \qmltype WaylandQuickItem * \inqmlmodule QtWayland.Compositor * \preliminary - * \brief A Qt Quick item representing a WaylandView. + * \brief Provides a Qt Quick item that represents a WaylandView. * - * When writing a WaylandCompositor in Qt Quick, this type can be used to display a - * client's contents on an output device and will pass user input to the + * Qt Quick-based Wayland compositors can use this type to display a client's + * contents on an output device. It passes user input to the * client. */ @@ -347,7 +347,7 @@ private: * \class QWaylandQuickItem * \inmodule QtWaylandCompositor * \preliminary - * \brief A Qt Quick item representing a QWaylandView. + * \brief The QWaylandQuickItem class provides a Qt Quick item representing a QWaylandView. * * When writing a QWaylandCompositor in Qt Quick, this class can be used to display a * client's contents on an output device and will pass user input to the @@ -402,7 +402,7 @@ QWaylandCompositor *QWaylandQuickItem::compositor() const } /*! - * \qmlproperty object QWaylandQuickItem::view + * \qmlproperty object QtWaylandCompositor::WaylandQuickItem::view * * This property holds the view rendered by this WaylandQuickItem. */ @@ -419,7 +419,7 @@ QWaylandView *QWaylandQuickItem::view() const } /*! - * \qmlproperty object QWaylandQuickItem::surface + * \qmlproperty object QtWaylandCompositor::WaylandQuickItem::surface * * This property holds the surface rendered by this WaylandQuickItem. */ @@ -944,7 +944,7 @@ void QWaylandQuickItem::updateSize() * This property specifies whether the WaylandQuickItem should take focus when * it is clicked. * - * The default is true. + * The default is \c true. */ /*! @@ -953,7 +953,7 @@ void QWaylandQuickItem::updateSize() * This property specifies whether the QWaylandQuickItem should take focus when * it is clicked. * - * The default is true. + * The default is \c true. */ bool QWaylandQuickItem::focusOnClick() const { @@ -972,7 +972,7 @@ void QWaylandQuickItem::setFocusOnClick(bool focus) } /*! - * Returns true if the input region of this item's surface contains the + * Returns \c true if the input region of this item's surface contains the * position given by \a localPosition. */ bool QWaylandQuickItem::inputRegionContains(const QPointF &localPosition) @@ -999,7 +999,7 @@ QPointF QWaylandQuickItem::mapToSurface(const QPointF &point) const * This property specifies whether the size of the item should always match * the size of its surface. * - * The default is true. + * The default is \c true. */ /*! @@ -1008,7 +1008,7 @@ QPointF QWaylandQuickItem::mapToSurface(const QPointF &point) const * This property specifies whether the size of the item should always match * the size of its surface. * - * The default is true. + * The default is \c true. */ bool QWaylandQuickItem::sizeFollowsSurface() const { @@ -1046,12 +1046,19 @@ QVariant QWaylandQuickItem::inputMethodQuery(Qt::InputMethodQuery query, QVarian #endif /*! - \qmlproperty bool QtWayland::QWaylandSurfaceItem::paintEnabled + \qmlproperty bool QtWaylandCompositor::WaylandQuickItem::paintEnabled + + If this property is \c true, the item is hidden, though the texture + is still updated. As opposed to hiding the item by + setting \l{Item::visible}{visible} to \c false, setting this property to \c true + will not prevent mouse or keyboard input from reaching item. +*/ - If this property is true, the \l item is hidden, though the texture - will still be updated. As opposed to hiding the \l item by - setting \l{Item::visible}{visible} to false, setting this property to true - will not prevent mouse or keyboard input from reaching \l item. +/*! + If this property is \c true, the item is hidden, though the texture + is still updated. As opposed to hiding the item by + setting \l{Item::visible}{visible} to \c false, setting this property to \c true + will not prevent mouse or keyboard input from reaching item. */ bool QWaylandQuickItem::paintEnabled() const { diff --git a/src/compositor/compositor_api/qwaylandquicksurface.cpp b/src/compositor/compositor_api/qwaylandquicksurface.cpp index 0fc07c6c5..30a94556f 100644 --- a/src/compositor/compositor_api/qwaylandquicksurface.cpp +++ b/src/compositor/compositor_api/qwaylandquicksurface.cpp @@ -87,7 +87,7 @@ QWaylandQuickSurface::~QWaylandQuickSurface() } /*! - * \qmlproperty QtWaylandCompositor::WaylandSurface::useTextureAlpha + * \qmlproperty bool QtWaylandCompositor::WaylandSurface::useTextureAlpha * * This property specifies whether the surface should use texture alpha. */ @@ -108,7 +108,7 @@ void QWaylandQuickSurface::setUseTextureAlpha(bool useTextureAlpha) } /*! - * \qmlproperty QtWaylandCompositor::WaylandSurface::clientRenderingEnabled + * \qmlproperty bool QtWaylandCompositor::WaylandSurface::clientRenderingEnabled * * This property specifies whether client rendering is enabled for the surface. */ diff --git a/src/compositor/compositor_api/qwaylandseat.cpp b/src/compositor/compositor_api/qwaylandseat.cpp index 1f5fd026e..f84325185 100644 --- a/src/compositor/compositor_api/qwaylandseat.cpp +++ b/src/compositor/compositor_api/qwaylandseat.cpp @@ -152,7 +152,7 @@ QWaylandKeymap::QWaylandKeymap(const QString &layout, const QString &variant, co * \class QWaylandSeat * \inmodule QtWaylandCompositor * \preliminary - * \brief The QWaylandSeat class provides access to keyboard, mouse and touch input. + * \brief The QWaylandSeat class provides access to keyboard, mouse, and touch input. * * The QWaylandSeat provides access to different types of user input and maintains * a keyboard focus and a mouse pointer. It corresponds to the wl_seat interface in the Wayland protocol. diff --git a/src/compositor/compositor_api/qwaylandsurface.cpp b/src/compositor/compositor_api/qwaylandsurface.cpp index 09eba77e0..ea94433bb 100644 --- a/src/compositor/compositor_api/qwaylandsurface.cpp +++ b/src/compositor/compositor_api/qwaylandsurface.cpp @@ -378,20 +378,20 @@ QtWayland::SurfaceBuffer *QWaylandSurfacePrivate::createSurfaceBuffer(struct ::w * \qmltype WaylandSurface * \inqmlmodule QtWayland.Compositor * \preliminary - * \brief A rectangular area which is displayed on an output device. + * \brief Represents a rectangular area on an output device. * * This type encapsulates a rectangular area of pixels that is displayed on an output device. It - * corresponds to the interface wl_surface in the Wayland protocol. + * corresponds to the interface \c wl_surface in the Wayland protocol. */ /*! * \class QWaylandSurface * \inmodule QtWaylandCompositor * \preliminary - * \brief A rectangular area which is displayed on an output device. + * \brief The QWaylandSurface class represents a rectangular area on an output device. * * This class encapsulates a rectangular area of pixels that is displayed on an output device. It - * corresponds to the interface wl_surface in the Wayland protocol. + * corresponds to the interface \c wl_surface in the Wayland protocol. */ /*! @@ -433,7 +433,7 @@ QWaylandSurface::~QWaylandSurface() /*! * \qmlmethod void QtWaylandCompositor::WaylandSurface::initialize(object compositor, object client, int id, int version) * - * Initializes the QWaylandSurface with the given \a compositor and \a client, and with the given \a id + * Initializes the WaylandSurface with the given \a compositor and \a client, and with the given \a id * and \a version. */ @@ -466,7 +466,7 @@ bool QWaylandSurface::isInitialized() const /*! * \qmlproperty object QtWaylandCompositor::WaylandSurface::client * - * This property holds the client using this QWaylandSurface. + * This property holds the client using this WaylandSurface. */ /*! @@ -543,7 +543,7 @@ int QWaylandSurface::bufferScale() const * * This property holds the orientation of the WaylandSurface's contents. * - * \sa QWaylandOutput::transform + * \sa {WaylandOutput::transform}{WaylandOutput.transform} */ /*! @@ -632,8 +632,8 @@ void QWaylandSurface::sendFrameCallbacks() } /*! - * Returns true if the QWaylandSurface's input region contains the point \a p. - * Otherwise returns false. + * Returns \c true if the QWaylandSurface's input region contains the point \a p. + * Otherwise returns \c false. */ bool QWaylandSurface::inputRegionContains(const QPoint &p) const { @@ -644,7 +644,7 @@ bool QWaylandSurface::inputRegionContains(const QPoint &p) const /*! * \qmlmethod void QtWaylandCompositor::WaylandSurface::destroy() * - * Destroys the QWaylandSurface. + * Destroys the WaylandSurface. */ /*! @@ -659,7 +659,7 @@ void QWaylandSurface::destroy() /*! * \qmlmethod bool QtWaylandCompositor::WaylandSurface::isDestroyed() * - * Returns true if the WaylandSurface has been destroyed. Otherwise returns false. + * Returns \c true if the WaylandSurface has been destroyed. Otherwise returns \c false. */ /*! @@ -701,9 +701,9 @@ QWaylandInputMethodControl *QWaylandSurface::inputMethodControl() const } /*! - * Updates the surface with the compositor's retained clipboard selection. While this - * is done automatically when the surface receives keyboard focus, this function is - * useful for updating clients which do not have keyboard focus. + * Updates the surface with the compositor's retained clipboard selection. Although + * this is done automatically when the surface receives keyboard focus, this + * function is useful for updating clients which do not have keyboard focus. */ void QWaylandSurface::updateSelection() { @@ -784,13 +784,11 @@ struct wl_resource *QWaylandSurface::resource() const } /*! - * Sets a role on the surface. A role defines how a surface will be mapped on screen, without a role - * a surface is supposed to be hidden. Only one role at all times can be set on a surface. Attempting - * to change the role of a surface will trigger a protocol error to the client, while setting the same - * role many times is allowed. + * Sets a \a role on the surface. A role defines how a surface will be mapped on screen, without a role + * a surface is supposed to be hidden. Only one role at all times can be set on a surface. Although + * setting the same role many times is allowed, attempting to change the role of a surface will trigger + * a protocol error to the \a errorResource and send an \a errorCode to the client. * - * \param errorResource The resource the error will be sent to if the role is being changed. - * \param errorCode The error code that will be sent to the client. */ bool QWaylandSurface::setRole(QWaylandSurfaceRole *role, wl_resource *errorResource, uint32_t errorCode) { diff --git a/src/compositor/compositor_api/qwaylandview.cpp b/src/compositor/compositor_api/qwaylandview.cpp index f605de55c..1f32bb61d 100644 --- a/src/compositor/compositor_api/qwaylandview.cpp +++ b/src/compositor/compositor_api/qwaylandview.cpp @@ -62,18 +62,20 @@ void QWaylandViewPrivate::markSurfaceAsDestroyed(QWaylandSurface *surface) * \preliminary * \brief Represents a view of a surface on an output. * - * The WaylandView corresponds to the presentation of a surface on a specific output, managing - * the buffers that contain the contents to be rendered. You can have several views into the same surface. + * The WaylandView corresponds to the presentation of a surface on a specific + * output, managing the buffers that contain the contents to be rendered. + * You can have several views into the same surface. */ /*! * \class QWaylandView * \inmodule QtWaylandCompositor * \preliminary - * \brief Represents a view of a surface on an output. + * \brief The QWaylandView class represents a view of a surface on an output. * - * The WaylandView corresponds to the presentation of a surface on a specific output, managing - * the buffers that contain the contents to be rendered. You can have several views into the same surface. + * The QWaylandView corresponds to the presentation of a surface on a specific + * output, managing the buffers that contain the contents to be rendered. + * You can have several views into the same surface. */ /*! @@ -104,20 +106,19 @@ QWaylandView::~QWaylandView() } /*! - \internal Didn't we decide to remove this property? +* \internal +* Didn't we decide to remove this property? */ QObject *QWaylandView::renderObject() const { Q_D(const QWaylandView); return d->renderObject; } - /*! - * \qmlproperty object QtWaylandCompositor::WaylandView::surface - * - * This property holds the surface viewed by this WaylandView. - */ - +* \qmlproperty object QtWaylandCompositor::WaylandView::surface +* +* This property holds the surface viewed by this WaylandView. +*/ /*! * \property QWaylandView::surface * @@ -163,7 +164,7 @@ void QWaylandView::setSurface(QWaylandSurface *newSurface) } /*! - * \qmlproperty object QtWaylandCompositor::WaylandView::surface + * \qmlproperty object QtWaylandCompositor::WaylandView::output * * This property holds the output on which this view displays its surface. */ @@ -197,8 +198,8 @@ void QWaylandView::setOutput(QWaylandOutput *newOutput) } /*! - * Attaches a new buffer \a ref and \a damage region to this QWaylandView. These - * will become current the next time advance() is called. + * Attaches a new buffer \a ref and a \a damage region to this QWaylandView. These + * will become current on a subsequent call to the advance() method. */ void QWaylandView::attach(const QWaylandBufferRef &ref, const QRegion &damage) { @@ -209,21 +210,20 @@ void QWaylandView::attach(const QWaylandBufferRef &ref, const QRegion &damage) } /*! - * Sets the next buffer and damage to current and returns true. If the buffer + * Sets the next buffer and damage region to current and returns \c true. If the buffer * is locked or if no new buffer has been attached since the last call to - * advance(), the function returns false and does nothing. + * advance(), the function returns \c false and does nothing. * - * If this view is set as its surface's throttling view, discardCurrentBuffer() - * will be called on all views of the same surface for which the + * If this view is set as the surface's throttling view, discardCurrentBuffer() + * is called on all views of the same surface for which the * \l{QWaylandView::allowDiscardFrontBuffer}{allowDiscardFrontBuffer} * property is set to true and the current buffer is the same as the * throttling view's current buffer. * - * This allows for a design where a primary - * view can make sure that views running on a lower frequency will release their - * front buffer references so that the buffer can be reused on the client side, - * avoiding the situation where the lower frequency views throttle the frame rate - * of the client application. + * To enable clients to reuse existing buffers, enable the primary view to ensure + * that views running on a lower frequency will release their front buffer + * references. This design approach should avoid the situation where the lower + * frequency views throttle the frame rate of the client application. */ bool QWaylandView::advance() { @@ -283,20 +283,20 @@ QRegion QWaylandView::currentDamage() * \qmlproperty bool QtWaylandCompositor::WaylandView::bufferLocked * * This property holds whether the view's buffer is currently locked. When - * the buffer is locked, advance() will not advance to the next buffer, - * but will instead return false. + * the buffer is locked, advance() will not advance to the next buffer and + * returns \c false. * - * The default is false. + * The default is \c false. */ /*! * \property QWaylandView::bufferLocked * * This property holds whether the view's buffer is currently locked. When - * the buffer is locked, advance() will not advance to the next buffer, - * but will instead return false. + * the buffer is locked, advance() will not advance to the next buffer + * and returns \c false. * - * The default is false. + * The default is \c false. */ bool QWaylandView::isBufferLocked() const { @@ -312,13 +312,19 @@ void QWaylandView::setBufferLocked(bool locked) d->bufferLocked = locked; emit bufferLockedChanged(); } - /*! - * \property bool QWaylandView::allowDiscardFrontBuffer + * \qmlproperty bool QtWaylandCompositor::WaylandView::allowDiscardFrontBuffer * * By default, the view locks the current buffer until advance() is called. Set this property * to true to allow Qt to release the buffer when the throttling view is no longer using it. */ + +/*! + * \property QWaylandView::allowDiscardFrontBuffer + * + * By default, the view locks the current buffer until advance() is called. Set this property + * to \c true to allow Qt to release the buffer when the throttling view is no longer using it. + */ bool QWaylandView::allowDiscardFrontBuffer() const { Q_D(const QWaylandView); |