Commit d17a3ff8 authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor Doxygen issues

parent 825aa4ac
......@@ -362,7 +362,7 @@ public:
virtual void updateMouseGrab();
/**
* @returns The caption consisting of @link{captionNormal} and @link{captionSuffix}
* @returns The caption consisting of captionNormal and captionSuffix
* @see captionNormal
* @see captionSuffix
**/
......@@ -454,13 +454,15 @@ public:
Q_INVOKABLE inline bool tabBefore(AbstractClient *other, bool activate) { return tabTo(other, false, activate); }
Q_INVOKABLE inline bool tabBehind(AbstractClient *other, bool activate) { return tabTo(other, true, activate); }
/**
* Syncs the *dynamic* @param property @param fromThisClient or the currentTab() to
* Syncs the *dynamic* @p property @p fromThisClient or the currentTab() to
* all members of the tabGroup() (if there is one)
*
* eg. if you call:
* @code
* client->setProperty("kwin_tiling_floats", true);
* client->syncTabGroupFor("kwin_tiling_floats", true)
* all clients in this tabGroup will have ::property("kwin_tiling_floats").toBool() == true
* @endcode
* all clients in this tabGroup will have property("kwin_tiling_floats").toBool() == true
*
* WARNING: non dynamic properties are ignored - you're not supposed to alter/update such explicitly
*/
......@@ -1040,7 +1042,7 @@ protected:
* Called from startMoveResize.
*
* Implementing classes should return @c false if starting move resize should
* get aborted. In that case @link startMoveResize will also return @c false.
* get aborted. In that case startMoveResize will also return @c false.
*
* Base implementation returns @c true.
**/
......
......@@ -106,7 +106,7 @@ Q_SIGNALS:
/**
* @brief Emits that the Night Color configuration has been changed.
*
* The provided variant hash provides the same fields as @link nightColorInfo
* The provided variant hash provides the same fields as nightColorInfo
*
* @return void
* @see nightColorInfo
......
......@@ -115,7 +115,7 @@ public Q_SLOTS:
/**
* @brief Suspends the Compositor if it is currently active.
*
* Note: it is possible that the Compositor is not able to suspend. Use @link isActive to check
* Note: it is possible that the Compositor is not able to suspend. Use isActive to check
* whether the Compositor has been suspended.
*
* @return void
......@@ -127,9 +127,9 @@ public Q_SLOTS:
* @brief Resumes the Compositor if it is currently suspended.
*
* Note: it is possible that the Compositor cannot be resumed, that is there might be Clients
* blocking the usage of Compositing or the Scene might be broken. Use @link isActive to check
* whether the Compositor has been resumed. Also check @link isCompositingPossible and
* @link isOpenGLBroken.
* blocking the usage of Compositing or the Scene might be broken. Use isActive to check
* whether the Compositor has been resumed. Also check isCompositingPossible and
* isOpenGLBroken.
*
* Note: The starting of the Compositor can require some time and is partially done threaded.
* After this method returns the setup may not have been completed.
......
......@@ -104,10 +104,10 @@ public:
/**
* @brief Enables tracking changes of cursor images.
*
* After enabling cursor change tracking the signal @link cursorChanged will be emitted
* After enabling cursor change tracking the signal cursorChanged will be emitted
* whenever a change to the cursor image is recognized.
*
* Use @link stopCursorTracking to no longer emit this signal. Note: the signal will be
* Use stopCursorTracking to no longer emit this signal. Note: the signal will be
* emitted until each call of this method has been matched with a call to stopCursorTracking.
*
* This tracking is not about pointer position tracking.
......@@ -145,7 +145,7 @@ public:
* Returns the current cursor position. This method does an update of the mouse position if
* needed. It's save to call it multiple times.
*
* Implementing subclasses should prefer to use @link currentPos which is not performing a check
* Implementing subclasses should prefer to use currentPos which is not performing a check
* for update.
**/
static QPoint pos();
......@@ -157,7 +157,7 @@ public:
static xcb_cursor_t x11Cursor(CursorShape shape);
/**
* Notice: if available always use the CursorShape variant to avoid cache duplicates for
* ambiguous cursor names in the non existing cursor name spcification
* ambiguous cursor names in the non existing cursor name specification
**/
static xcb_cursor_t x11Cursor(const QByteArray &name);
......@@ -179,13 +179,13 @@ Q_SIGNALS:
protected:
/**
* Called from @link x11Cursor to actually retrieve the X11 cursor. Base implementation returns
* Called from x11Cursor to actually retrieve the X11 cursor. Base implementation returns
* a null cursor, an implementing subclass should implement this method if it can provide X11
* mouse cursors.
**/
virtual xcb_cursor_t getX11Cursor(CursorShape shape);
/**
* Called from @link x11Cursor to actually retrieve the X11 cursor. Base implementation returns
* Called from x11Cursor to actually retrieve the X11 cursor. Base implementation returns
* a null cursor, an implementing subclass should implement this method if it can provide X11
* mouse cursors.
**/
......@@ -195,27 +195,27 @@ protected:
**/
virtual void doSetPos();
/**
* Called from @link pos() to allow syncing the internal position with the underlying
* Called from @ref pos() to allow syncing the internal position with the underlying
* system's cursor position.
**/
virtual void doGetPos();
/**
* Called from @link startMousePolling when the mouse polling gets activated. Base implementation
* Called from startMousePolling when the mouse polling gets activated. Base implementation
* does nothing, inheriting classes can overwrite to e.g. start a timer.
**/
virtual void doStartMousePolling();
/**
* Called from @link stopMousePolling when the mouse polling gets deactivated. Base implementation
* Called from stopMousePolling when the mouse polling gets deactivated. Base implementation
* does nothing, inheriting classes can overwrite to e.g. stop a timer.
**/
virtual void doStopMousePolling();
/**
* Called from @link startCursorTracking when cursor image tracking gets activated. Inheriting class needs
* Called from startCursorTracking when cursor image tracking gets activated. Inheriting class needs
* to overwrite to enable platform specific code for the tracking.
*/
virtual void doStartCursorTracking();
/**
* Called from @link stopCursorTracking when cursor image tracking gets deactivated. Inheriting class needs
* Called from stopCursorTracking when cursor image tracking gets deactivated. Inheriting class needs
* to overwrite to disable platform specific code for the tracking.
*/
virtual void doStopCursorTracking();
......@@ -228,7 +228,7 @@ protected:
const QPoint &currentPos() const;
/**
* Updates the internal position to @p pos without warping the pointer as
* @link setPos does.
* setPos does.
**/
void updatePos(const QPoint &pos);
void updatePos(int x, int y);
......
......@@ -139,7 +139,7 @@ public Q_SLOTS:
/**
* @brief Suspends the Compositor if it is currently active.
*
* Note: it is possible that the Compositor is not able to suspend. Use @link isActive to check
* Note: it is possible that the Compositor is not able to suspend. Use isActive to check
* whether the Compositor has been suspended.
*
* @return void
......@@ -151,9 +151,9 @@ public Q_SLOTS:
* @brief Resumes the Compositor if it is currently suspended.
*
* Note: it is possible that the Compositor cannot be resumed, that is there might be Clients
* blocking the usage of Compositing or the Scene might be broken. Use @link isActive to check
* whether the Compositor has been resumed. Also check @link isCompositingPossible and
* @link isOpenGLBroken.
* blocking the usage of Compositing or the Scene might be broken. Use isActive to check
* whether the Compositor has been resumed. Also check isCompositingPossible and
* isOpenGLBroken.
*
* Note: The starting of the Compositor can require some time and is partially done threaded.
* After this method returns the setup may not have been completed.
......
......@@ -42,8 +42,8 @@ protected:
Q_SIGNALS:
/**
* Matching of a gesture started and this Gesture might match.
* On further evaluation either the signal @link{triggered} or
* @link{cancelled} will get emitted.
* On further evaluation either the signal @ref triggered or
* @ref cancelled will get emitted.
**/
void started();
/**
......@@ -158,7 +158,7 @@ public:
Q_SIGNALS:
/**
* The progress of the gesture if a @link{minimumDelta} is set.
* The progress of the gesture if a minimumDelta is set.
* The progress is reported in [0.0,1.0]
**/
void progress(qreal);
......
......@@ -439,7 +439,7 @@ public:
}
/**
* The id of the screen in KWin identifiers. Set from KWin through @link setScreenId.
* The id of the screen in KWin identifiers. Set from KWin through setScreenId.
**/
int screenId() const {
return m_screenId;
......
......@@ -921,11 +921,11 @@ public:
* Registers the given @p action for the given @p border to be activated through
* a touch swipe gesture.
*
* If the @p border gets triggered through a touch swipe gesture the @link{QAction::triggered}
* If the @p border gets triggered through a touch swipe gesture the QAction::triggered
* signal gets invoked.
*
* To unregister the touch screen action either delete the @p action or
* invoke @link{unregisterTouchBorder}.
* invoke unregisterTouchBorder.
*
* @see unregisterTouchBorder
* @since 5.10
......@@ -1131,9 +1131,9 @@ public:
*
* The Effect will be notified for events through the signal propertyNotify().
*
* To remove the support again use @link removeSupportProperty. When an Effect is
* To remove the support again use removeSupportProperty. When an Effect is
* destroyed it is automatically taken care of removing the support. It is not
* required to call @link removeSupportProperty in the Effect's cleanup handling.
* required to call removeSupportProperty in the Effect's cleanup handling.
*
* @param propertyName The name of the property to announce support for
* @param effect The effect which announces support
......@@ -1295,7 +1295,7 @@ public:
virtual void startInteractivePositionSelection(std::function<void(const QPoint &)> callback) = 0;
/**
* Shows an on-screen-message. To hide it again use @link{hideOnScreenMessage}.
* Shows an on-screen-message. To hide it again use hideOnScreenMessage.
*
* @param message The message to show
* @param iconName The optional themed icon name
......@@ -1420,10 +1420,10 @@ Q_SIGNALS:
/**
* Signal emitted when a user begins a window move or resize operation.
* To figure out whether the user resizes or moves the window use
* @ref EffectWindow::isUserMove or @link EffectWindow::isUserResize.
* Whenever the geometry is updated the signal @link windowStepUserMovedResized
* @ref EffectWindow::isUserMove or @ref EffectWindow::isUserResize.
* Whenever the geometry is updated the signal @ref windowStepUserMovedResized
* is emitted with the current geometry.
* The move/resize operation ends with the signal @link windowFinishUserMovedResized.
* The move/resize operation ends with the signal @ref windowFinishUserMovedResized.
* Only one window can be moved/resized by the user at the same time!
* @param w The window which is being moved/resized
* @see windowStepUserMovedResized
......@@ -1544,7 +1544,7 @@ Q_SIGNALS:
void tabBoxAdded(int mode);
/**
* Signal emitted when the TabBox was closed by KWin core.
* An effect which referenced the TabBox should use @link unrefTabBox to unref again.
* An effect which referenced the TabBox should use unrefTabBox to unref again.
* @see unrefTabBox
* @see tabBoxAdded
* @since 4.7
......@@ -1564,7 +1564,7 @@ Q_SIGNALS:
/**
* Signal emitted when a key event, which is not handled by TabBox directly is, happens while
* TabBox is active. An effect might use the key event to e.g. change the selected window.
* An effect should only response to this signal if it referenced the TabBox with @link refTabBox.
* An effect should only response to this signal if it referenced the TabBox with refTabBox.
* @param event The key event not handled by TabBox directly
* @see refTabBox
* @since 4.7
......@@ -1676,7 +1676,7 @@ Q_SIGNALS:
/**
* The window @p w gets shown again. The window was previously
* initially shown with @link{windowAdded} and hidden with @link{windowHidden}.
* initially shown with windowAdded and hidden with windowHidden.
*
* @see windowHidden
* @see windowAdded
......@@ -1687,7 +1687,7 @@ Q_SIGNALS:
/**
* The window @p w got hidden but not yet closed.
* This can happen when a window is still being used and is supposed to be shown again
* with @link{windowShown}. On X11 an example is autohiding panels. On Wayland every
* with windowShown. On X11 an example is autohiding panels. On Wayland every
* window first goes through the window hidden state and might get shown again, or might
* get closed the normal way.
*
......@@ -1717,7 +1717,7 @@ Q_SIGNALS:
* got destroyed.
* Effects can use this to refetch the properties they want to set.
*
* When the xcbConnection changes also the @link{x11RootWindow} becomes invalid.
* When the xcbConnection changes also the x11RootWindow becomes invalid.
* @see xcbConnection
* @see x11RootWindow
* @since 5.11
......
......@@ -282,7 +282,7 @@ public:
* Creates a custom shader with the given @p traits and custom @p vertexFile and or @p fragmentFile.
* The file names specified in @p vertexFile and @p fragmentFile are relative paths to the shaders
* resource file shipped together with KWin. This means this method can only be used for built-in
* effects, for 3rd party effects @link {generateCustomShader} should be used.
* effects, for 3rd party effects generateCustomShader should be used.
*
* If the @p vertexFile is empty a vertex shader with the given @p traits is generated.
* If it is not empty the @p vertexFile is used as the source for the vertex shader.
......@@ -490,7 +490,7 @@ public:
/**
* Blits the content of the current draw framebuffer into the texture attached to this FBO.
*
* Be aware that framebuffer blitting may not be supported on all hardware. Use @link blitSupported to check whether
* Be aware that framebuffer blitting may not be supported on all hardware. Use blitSupported to check whether
* it is supported.
* @param source Geometry in screen coordinates which should be blitted, if not specified complete framebuffer is used
* @param destination Geometry in attached texture, if not specified complete texture is used as destination
......
......@@ -182,8 +182,8 @@ class KWIN_EXPORT Options : public QObject
Q_PROPERTY(bool glStrictBinding READ isGlStrictBinding WRITE setGlStrictBinding NOTIFY glStrictBindingChanged)
/**
* Whether strict binding follows the driver or has been overwritten by a user defined config value.
* If @c true @link glStrictBinding is set by the OpenGL Scene during initialization.
* If @c false @link glStrictBinding is set from a config value and not updated during scene initialization.
* If @c true glStrictBinding is set by the OpenGL Scene during initialization.
* If @c false glStrictBinding is set from a config value and not updated during scene initialization.
**/
Q_PROPERTY(bool glStrictBindingFollowsDriver READ isGlStrictBindingFollowsDriver WRITE setGlStrictBindingFollowsDriver NOTIFY glStrictBindingFollowsDriverChanged)
Q_PROPERTY(bool glCoreProfile READ glCoreProfile WRITE setGLCoreProfile NOTIFY glCoreProfileChanged)
......
......@@ -185,7 +185,7 @@ public:
virtual bool requiresCompositing() const;
/**
* Whether Compositing is possible in the Platform.
* Returning @c false in this method makes only sense if @link{requiresCompositing} returns @c false.
* Returning @c false in this method makes only sense if requiresCompositing returns @c false.
*
* The default implementation returns @c true.
* @see requiresCompositing
......@@ -193,7 +193,7 @@ public:
virtual bool compositingPossible() const;
/**
* Returns a user facing text explaining why compositing is not possible in case
* @link{compositingPossible} returns @c false.
* compositingPossible returns @c false.
*
* The default implementation returns an empty string.
* @see compositingPossible
......@@ -218,7 +218,7 @@ public:
/**
* This method is invoked before and after creating the OpenGL rendering Scene.
* An implementing Platform can use it to detect crashes triggered by the OpenGL implementation.
* This can be used for @link{openGLCompositingIsBroken}.
* This can be used for openGLCompositingIsBroken.
*
* The default implementation does nothing.
* @see openGLCompositingIsBroken.
......
......@@ -379,17 +379,17 @@ private:
};
/**
* @brief Wrapper for a pixmap of the @link Scene::Window.
* @brief Wrapper for a pixmap of the Scene::Window.
*
* This class encapsulates the functionality to get the pixmap for a window. When initialized the pixmap is not yet
* mapped to the window and @link isValid will return @c false. The pixmap mapping to the window can be established
* through @link create. If it succeeds @link isValid will return @c true, otherwise it will keep in the non valid
* mapped to the window and isValid will return @c false. The pixmap mapping to the window can be established
* through @ref create. If it succeeds isValid will return @c true, otherwise it will keep in the non valid
* state and it can be tried to create the pixmap mapping again (e.g. in the next frame).
*
* This class is not intended to be updated when the pixmap is no longer valid due to e.g. resizing the window.
* Instead a new instance of this class should be instantiated. The idea behind this is that a valid pixmap does not
* get destroyed, but can continue to be used. To indicate that a newer pixmap should in generally be around, one can
* use @link markAsDiscarded.
* use markAsDiscarded.
*
* This class is intended to be inherited for the needs of the compositor backends which need further mapping from
* the native pixmap to the respective rendering format.
......@@ -401,7 +401,7 @@ public:
/**
* @brief Tries to create the mapping between the Window and the pixmap.
*
* In case this method succeeds in creating the pixmap for the window, @link isValid will return @c true otherwise
* In case this method succeeds in creating the pixmap for the window, isValid will return @c true otherwise
* @c false.
*
* Inheriting classes should re-implement this method in case they need to add further functionality for mapping the
......@@ -430,7 +430,7 @@ public:
*/
bool isDiscarded() const;
/**
* @brief Marks this WindowPixmap as discarded. From now on @link isDiscarded will return @c true. This method should
* @brief Marks this WindowPixmap as discarded. From now on isDiscarded will return @c true. This method should
* only be used by the Window when it changes in a way that a new pixmap is required.
*
* @see isDiscarded
......
......@@ -116,7 +116,7 @@ public:
/**
* The virtual bounding size of all screens combined.
* The default implementation returns the same as @link{size} and that is the
* The default implementation returns the same as @ref size and that is the
* method which should be preferred.
*
* This method is only for cases where the platform specific implementation needs
......
......@@ -31,10 +31,10 @@ namespace KWin
* session bus.
*
* Allows to setup the connection arguments just like in QDBusMessage and supports
* adding arguments to the call. To invoke the message use the slot @link call.
* adding arguments to the call. To invoke the message use the slot @ref call.
*
* If the call succeeds the signal @link finished is emitted, if the call fails
* the signal @link failed is emitted.
* If the call succeeds the signal @ref finished is emitted, if the call fails
* the signal @ref failed is emitted.
*
* Note: the DBusCall always uses the session bus and performs an async call.
*
......
......@@ -32,7 +32,7 @@ namespace KWin
* @brief Qml export for reserving a Screen Edge.
*
* The edge is controlled by the @c enabled property and the @c edge
* property. If the edge is enabled and gets triggered the @link activated()
* property. If the edge is enabled and gets triggered the @ref activated()
* signal gets emitted.
*
* Example usage:
......
......@@ -107,8 +107,8 @@ private:
* @brief The data structure of the Model.
*
* The model is implemented as a Tree consisting of AbstractLevels as the levels of the tree.
* A non leaf level is represented by the inheriting class @link ForkLevel, the last level above a
* leaf is represented by the inheriting class @link ClientLevel, which contains the Clients - each
* A non leaf level is represented by the inheriting class ForkLevel, the last level above a
* leaf is represented by the inheriting class ClientLevel, which contains the Clients - each
* Client is one leaf.
*
* In case the tree would only consist of Clients - leafs - it has always one ClientLevel as the root
......@@ -117,8 +117,8 @@ private:
* The number of levels in the tree is controlled by the LevelRestrictions. For each existing
* LevelRestriction a new Level is created, if there are no more restrictions a ClientLevel is created.
*
* To build up the tree the static factory method @link create has to be used. It will recursively
* build up the tree. After the tree has been build up use @link init to initialize the tree which
* To build up the tree the static factory method @ref create has to be used. It will recursively
* build up the tree. After the tree has been build up use @ref init to initialize the tree which
* will add the Clients to the ClientLevel.
*
* Each element of the tree has a unique id which can be used by the QAbstractItemModel as the
......
......@@ -333,7 +333,7 @@ public Q_SLOTS:
/**
* Shows an outline at the specified @p geometry.
* If an outline is already shown the outline is moved to the new position.
* Use @link hideOutline to remove the outline again.
* Use hideOutline to remove the outline again.
**/
void showOutline(const QRect &geometry);
/**
......@@ -341,7 +341,7 @@ public Q_SLOTS:
**/
void showOutline(int x, int y, int width, int height);
/**
* Hides the outline previously shown by @link showOutline.
* Hides the outline previously shown by showOutline.
**/
void hideOutline();
......
......@@ -50,7 +50,7 @@ class Toplevel;
* window during the Compositing stage. The Shadow consists of several pixmaps and offsets.
* For a complete description please refer to http://community.kde.org/KWin/Shadow
*
* To create a Shadow instance use the static factory method @link createShadow which will
* To create a Shadow instance use the static factory method createShadow which will
* create an instance for the currently used Compositing Backend. It will read the X11 Property
* and create the Shadow and all required data (such as WindowQuads). If there is no Shadow
* defined for the Toplevel the factory method returns @c NULL.
......
......@@ -126,7 +126,7 @@ public:
* as a starting point to construct the recently used list.
*
* In case the @p client is not in the focus chain it is recommended to use the
* Client returned by @link firstClientFocusChain.
* Client returned by firstClientFocusChain.
*
* The method accepts a @c null Client and in that case @c false is returned.
* @param client The Client to check whether it is in the Focus Chain
......
......@@ -221,7 +221,7 @@ public:
virtual xcb_window_t frameId() const;
xcb_window_t window() const;
/**
* @return a unique identifier for the Toplevel. On X11 same as @link {window}
* @return a unique identifier for the Toplevel. On X11 same as @ref window
**/
virtual quint32 windowId() const;
QRect geometry() const;
......@@ -353,7 +353,7 @@ public:
* Returns the pointer to the Toplevel's Shadow. A Shadow
* is only available if Compositing is enabled and the corresponding X window
* has the Shadow property set.
* If a shadow is available @link hasShadow returns @c true.
* If a shadow is available hasShadow returns @c true.
* @returns The Shadow belonging to this Toplevel, may be @c NULL.
* @see hasShadow
**/
......@@ -372,7 +372,7 @@ public:
/**
* This method returns the area that the Toplevel window reports to be opaque.
* It is supposed to only provide valuable information if @link hasAlpha is @c true .
* It is supposed to only provide valuable information if hasAlpha is @c true .
* @see hasAlpha
**/
const QRegion& opaqueRegion() const;
......
......@@ -163,8 +163,8 @@ bool KWIN_EXPORT grabXKeyboard(xcb_window_t w = XCB_WINDOW_NONE);
void KWIN_EXPORT ungrabXKeyboard();
/**
* Small helper class which performs @link grabXServer in the ctor and
* @link ungrabXServer in the dtor. Use this class to ensure that grab and
* Small helper class which performs grabXServer in the ctor and
* ungrabXServer in the dtor. Use this class to ensure that grab and
* ungrab are matched.
*
* To simplify usage consider using the macro GRAB_SERVER_DURING_CONTEXT
......
......@@ -323,10 +323,10 @@ public Q_SLOTS:
* grid layout.
* There needs to be at least one virtual desktop and the new value is capped at the maximum
* number of desktops. A caller of this function cannot expect that the change has been applied.
* It is the callers responsibility to either check the @link numberOfDesktops or connect to the
* It is the callers responsibility to either check the numberOfDesktops or connect to the
* countChanged signal.
*
* In case the @link current desktop is on a desktop higher than the new count, the current desktop
* In case the @ref current desktop is on a desktop higher than the new count, the current desktop
* is changed to be the new desktop with highest id. In that situation the signal desktopRemoved
* is emitted.
* @param count The new number of desktops to use
......
......@@ -1307,14 +1307,14 @@ private:
* Furthermore the class provides wrappers around some xcb methods operating on an xcb_window_t.
*
* For the cases that one is more interested in wrapping the xcb methods the constructor which takes
* an existing window and the @link reset method allow to disable the RAII functionality.
* an existing window and the @ref reset method allow to disable the RAII functionality.
**/
class Window
{
public:
/**
* Takes over responsibility of @p window. If @p window is not provided an invalid Window is
* created. Use @link create to set an xcb_window_t later on.
* created. Use @ref create to set an xcb_window_t later on.
*
* If @p destroy is @c true the window will be destroyed together with this object, if @c false
* the window will be kept around. This is useful if you are not interested in the RAII capabilities
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment