yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix minor Doxygen issues

Browse source
This commit is contained in:
Yuri Chornoivan 2019-01-11 15:36:17 +02:00
parent 4fac71d697
commit 9dbb74afb7
12 changed files with 44 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
abstract_client.h
View file

@ -287,7 +287,7 @@ class KWIN_EXPORT AbstractClient : public Toplevel
* The color scheme set on this client
* Absolute file path, or name of palette in the user's config directory following KColorSchemes format.
* An empty string indicates the default palette from kdeglobals is used.
* @Note this indicates the colour scheme requested, which might differ from the theme applied if the colorScheme cannot be found
* @note this indicates the colour scheme requested, which might differ from the theme applied if the colorScheme cannot be found
*/
Q_PROPERTY(QString colorScheme READ colorScheme NOTIFY colorSchemeChanged)
@ -454,8 +454,8 @@ 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 @link currentTab() to
* all members of the @link tabGroup() (if there is one)
* Syncs the *dynamic* @param property @param fromThisClient or the currentTab() to
* all members of the tabGroup() (if there is one)
*
* eg. if you call:
* client->setProperty("kwin_tiling_floats", true);
@ -818,28 +818,28 @@ protected:
**/
virtual bool acceptsFocus() const = 0;
/**
* Called from ::setActive once the active value got updated, but before the changed signal
* Called from setActive once the active value got updated, but before the changed signal
* is emitted.
*
* Default implementation does nothing.
**/
virtual void doSetActive();
/**
* Called from ::setKeepAbove once the keepBelow value got updated, but before the changed signal
* Called from setKeepAbove once the keepBelow value got updated, but before the changed signal
* is emitted.
*
* Default implementation does nothing.
**/
virtual void doSetKeepAbove();
/**
* Called from ::setKeepBelow once the keepBelow value got updated, but before the changed signal
* Called from setKeepBelow once the keepBelow value got updated, but before the changed signal
* is emitted.
*
* Default implementation does nothing.
**/
virtual void doSetKeepBelow();
/**
* Called from ::setDeskop once the desktop value got updated, but before the changed signal
* Called from setDeskop once the desktop value got updated, but before the changed signal
* is emitted.
*
* Default implementation does nothing.
@ -848,7 +848,7 @@ protected:
**/
virtual void doSetDesktop(int desktop, int was_desk);
/**
* Called from ::minimize and ::unminimize once the minimized value got updated, but before the
* Called from @ref minimize and @ref unminimize once the minimized value got updated, but before the
* changed signal is emitted.
*
* Default implementation does nothig.
@ -1012,7 +1012,7 @@ protected:
void stopDelayedMoveResize();
bool startMoveResize();
/**
* Called from @link startMoveResize.
* 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.

6
cursor.h
View file

@ -118,7 +118,7 @@ public:
/**
* @brief Disables tracking changes of cursor images.
*
* Only call after using @link startCursorTracking.
* Only call after using startCursorTracking.
*
* @see startCursorTracking
*/
@ -169,7 +169,7 @@ Q_SIGNALS:
/**
* @brief Signal emitted when the cursor image changes.
*
* To enable these signals use @link startCursorTracking.
* To enable these signals use startCursorTracking.
*
* @see startCursorTracking
* @see stopCursorTracking
@ -222,7 +222,7 @@ protected:
bool isCursorTracking() const;
/**
* Provides the actual internal cursor position to inheriting classes. If an inheriting class needs
* access to the cursor position this method should be used instead of the static @link pos, as
* access to the cursor position this method should be used instead of the static @ref pos, as
* the static method syncs with the underlying system's cursor.
**/
const QPoint &currentPos() const;

2
input.h
View file

@ -259,7 +259,7 @@ Q_SIGNALS:
* @brief Emitted when the state of a key changed.
*
* @param keyCode The keycode of the key which changed
* @param oldMods The new key state
* @param state The new key state
*/
void keyStateChanged(quint32 keyCode, InputRedirection::KeyboardKeyState state);

6
libkwineffects/kwinanimationeffect.h
View file

@ -248,7 +248,7 @@ protected:
* @param to The target value. FPx2 is an agnostic two component float type
* (like QPointF or QSizeF, but without requiring to be either and supporting
* an invalid state).
* @param shape How the animation progresses, e.g. Linear progresses constantly
* @param curve How the animation progresses, e.g. Linear progresses constantly
* while Exponential start slow and becomes very fast in the end.
* @param delay When the animation will start compared to "now" (the window will
* remain at the "from" position until then).
@ -278,7 +278,7 @@ protected:
* @param to The target value. FPx2 is an agnostic two component float type
* (like QPointF or QSizeF, but without requiring to be either and supporting
* an invalid state).
* @param shape How the animation progresses, e.g. Linear progresses constantly
* @param curve How the animation progresses, e.g. Linear progresses constantly
* while Exponential start slow and becomes very fast in the end.
* @param delay When the animation will start compared to "now" (the window will
* remain at the "from" position until then).
@ -313,7 +313,7 @@ protected:
*
* @param animationId The id of the animation.
* @param direction The new direction of the animation.
* @param terminationPolicy Whether the animation should be terminated when it
* @param terminationFlags Whether the animation should be terminated when it
* reaches the source position after its direction was changed to go backward.
* Currently, TerminationFlag::TerminateAtTarget has no effect.
* @returns @c true if the direction of the animation was changed successfully,

22
libkwineffects/kwineffects.h
View file

@ -1259,7 +1259,7 @@ public:
virtual void hideCursor() = 0;
/**
* The cursor image should be shown again after having been hidden..
* The cursor image should be shown again after having been hidden.
* @see hideCursor
* @since 5.9
**/
@ -1394,7 +1394,7 @@ Q_SIGNALS:
* Signal emitted when a window is being removed from the Workspace.
* An effect which wants to animate the window closing should connect
* to this signal and reference the window by using
* @link EffectWindow::refWindow
* @ref EffectWindow::refWindow
* @param w The window which is being closed
* @since 4.7
**/
@ -1420,7 +1420,7 @@ 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
* @link EffectWindow::isUserMove or @link EffectWindow::isUserResize.
* @ref EffectWindow::isUserMove or @link EffectWindow::isUserResize.
* Whenever the geometry is updated the signal @link windowStepUserMovedResized
* is emitted with the current geometry.
* The move/resize operation ends with the signal @link windowFinishUserMovedResized.
@ -1464,7 +1464,7 @@ Q_SIGNALS:
* @li restored: both @p horizontal and @p vertical are @c false
* @li horizontally maximized: @p horizontal is @c true and @p vertical is @c false
* @li vertically maximized: @p horizontal is @c false and @p vertical is @c true
* @li completely maximized: both @p horizontal and @p vertical are @C true
* @li completely maximized: both @p horizontal and @p vertical are @c true
* @param w The window whose maximized state changed
* @param horizontal If @c true maximized horizontally
* @param vertical If @c true maximized vertically
@ -1533,7 +1533,7 @@ Q_SIGNALS:
void windowDamaged(KWin::EffectWindow *w, const QRect &r);
/**
* Signal emitted when a tabbox is added.
* An effect who wants to replace the tabbox with itself should use @link refTabBox.
* An effect who wants to replace the tabbox with itself should use refTabBox.
* @param mode The TabBoxMode.
* @see refTabBox
* @see tabBoxClosed
@ -1552,7 +1552,7 @@ Q_SIGNALS:
void tabBoxClosed();
/**
* Signal emitted when the selected TabBox window changed or the TabBox List changed.
* 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.
* @see refTabBox
* @see currentTabBoxWindowList
* @see currentTabBoxDesktopList
@ -1575,8 +1575,8 @@ Q_SIGNALS:
void tabRemoved(KWin::EffectWindow* c, KWin::EffectWindow* group); // c removed from group
/**
* Signal emitted when mouse changed.
* If an effect needs to get updated mouse positions, it needs to first call @link startMousePolling.
* For a fullscreen effect it is better to use an input window and react on @link windowInputMouseEvent.
* If an effect needs to get updated mouse positions, it needs to first call startMousePolling.
* For a fullscreen effect it is better to use an input window and react on windowInputMouseEvent.
* @param pos The new mouse position
* @param oldpos The previously mouse position
* @param buttons The pressed mouse buttons
@ -1596,7 +1596,7 @@ Q_SIGNALS:
*/
void cursorShapeChanged();
/**
* Receives events registered for using @link registerPropertyType.
* Receives events registered for using registerPropertyType.
* Use readProperty() to get the property data.
* Note that the property may be already set on the window, so doing the same
* processing from windowAdded() (e.g. simply calling propertyNotify() from it)
@ -2340,7 +2340,7 @@ public:
* window pixmap an effect can for example cross fade the current window pixmap with the previous
* one. This allows for smoother transitions for window geometry changes.
*
* If an effect calls this method on a window it also needs to call @link unreferencePreviousWindowPixmap
* If an effect calls this method on a window it also needs to call unreferencePreviousWindowPixmap
* once it does no longer need the previous window pixmap.
*
* Note: the window pixmap is not kept forever even when referenced. If the geometry changes again, so that
@ -2353,7 +2353,7 @@ public:
*/
virtual void referencePreviousWindowPixmap() = 0;
/**
* @brief Unreferences the previous window pixmap. Only relevant after @link referencePreviousWindowPixmap had
* @brief Unreferences the previous window pixmap. Only relevant after referencePreviousWindowPixmap had
* been called.
*
* @see referencePreviousWindowPixmap

4
libkwineffects/kwinglutils.h
View file

@ -235,7 +235,7 @@ public:
/**
* Binds the @p shader.
* To unbind the shader use @link popShader. A previous bound shader will be rebound.
* To unbind the shader use popShader. A previous bound shader will be rebound.
* To bind a built-in shader use the more specific method.
* @param shader The shader to be bound
* @see popShader
@ -271,7 +271,7 @@ public:
* If neither are provided a new shader following the @p traits is generated.
*
* @param traits The shader traits for generating the shader
* @param vertesSource optional vertex shader source code to be used instead of shader traits
* @param vertexSource optional vertex shader source code to be used instead of shader traits
* @param fragmentSource optional fragment shader source code to be used instead of shader traits
* @return new generated shader
* @since 5.6

8
outline.h
View file

@ -54,7 +54,7 @@ public:
/**
* Set the outline geometry.
* To show the outline use @link showOutline.
* To show the outline use showOutline.
* @param outlineGeometry The geometry of the outline to be shown
* @see showOutline
*/
@ -70,7 +70,7 @@ public:
/**
* Shows the outline of a window using either an effect or the X implementation.
* To stop the outline process use @link hideOutline.
* To stop the outline process use hideOutline.
* @see hideOutline
*/
void show();
@ -78,7 +78,7 @@ public:
/**
* Shows the outline for the given @p outlineGeometry.
* This is the same as setOutlineGeometry followed by showOutline directly.
* To stop the outline process use @link hideOutline.
* To stop the outline process use hideOutline.
* @param outlineGeometry The geometry of the outline to be shown
* @see hideOutline
*/
@ -88,7 +88,7 @@ public:
* Shows the outline for the given @p outlineGeometry animated from @p visualParentGeometry.
* This is the same as setOutlineGeometry followed by setVisualParentGeometry
* and then showOutline.
* To stop the outline process use @link hideOutline.
* To stop the outline process use hideOutline.
* @param outlineGeometry The geometry of the outline to be shown
* @param visualParentGeometry The geometry from where the outline should emerge
* @see hideOutline

6
scene.h
View file

@ -343,11 +343,11 @@ protected:
/**
* @brief Returns the WindowPixmap for this Window.
*
* If the WindowPixmap does not yet exist, this method will invoke @link createWindowPixmap.
* If the WindowPixmap does not yet exist, this method will invoke createWindowPixmap.
* If the WindowPixmap is not valid it tries to create it, in case this succeeds the WindowPixmap is
* returned. In case it fails, the previous (and still valid) WindowPixmap is returned.
*
* Note: this method can return @c NULL as there might neither be a valid previous nor current WindowPixmap
* @note This method can return @c NULL as there might neither be a valid previous nor current WindowPixmap
* around.
*
* The WindowPixmap gets casted to the type passed in as a template parameter. That way this class does not
@ -361,7 +361,7 @@ protected:
* @brief Factory method to create a WindowPixmap.
*
* The inheriting classes need to implement this method to create a new instance of their WindowPixmap subclass.
* Note: do not use @link WindowPixmap::create on the created instance. The Scene will take care of that.
* @note Do not use WindowPixmap::create on the created instance. The Scene will take care of that.
*/
virtual WindowPixmap *createWindowPixmap() = 0;
Toplevel* toplevel;

2
screenedge.h
View file

@ -163,7 +163,7 @@ private:
* The screen edge functionality is split into three parts:
* @li This manager class ScreenEdges
* @li abstract class @ref Edge
* @li specific implementation of @ref Edge, e.g. @ref WindowBasedEdge
* @li specific implementation of @ref Edge, e.g. WindowBasedEdge
*
* The ScreenEdges creates an @ref Edge for each screen edge which is also an edge in the
* combination of all screens. E.g. if there are two screens, no Edge is created between the screens,

2
toplevel.h
View file

@ -244,7 +244,7 @@ public:
int screen() const; // the screen where the center is
/**
* The scale of the screen this window is currently on
* @Note: The buffer scale can be different.
* @note The buffer scale can be different.
* @since 5.12
*/
qreal screenScale() const; //

6
virtualdesktops.h
View file

@ -324,10 +324,10 @@ public Q_SLOTS:
* 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
* @link countChanged signal.
* countChanged signal.
*
* In case the @link 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 @link desktopRemoved
* 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
* @see count
@ -386,7 +386,7 @@ Q_SIGNALS:
/**
* Signal when the number of rows in the layout changes
* @param new number of rows
* @param rows number of rows
*/
void rowsChanged(uint rows);

6
xcbutils.h
View file

@ -1338,7 +1338,7 @@ public:
* Creates an xcb_window_t and manages it. It's a convenient method to create a window with
* depth and visual being copied from parent and border being @c 0.
* @param geometry The geometry for the window to be created
* @param class The window class
* @param windowClass The window class
* @param mask The mask for the values
* @param values The values to be passed to xcb_create_window
* @param parent The parent window
@ -1364,7 +1364,7 @@ public:
*
* Depth and visual are being copied from parent and border is @c 0.
* @param geometry The geometry for the window to be created
* @param class The window class
* @param windowClass The window class
* @param mask The mask for the values
* @param values The values to be passed to xcb_create_window
* @param parent The parent window
@ -1381,11 +1381,11 @@ public:
* @returns @c true if a window is managed, @c false otherwise.
**/
bool isValid() const;
inline const QRect &geometry() const { return m_logicGeometry; }
/**
* Configures the window with a new geometry.
* @param geometry The new window geometry to be used
**/
inline const QRect &geometry() const { return m_logicGeometry; }
void setGeometry(const QRect &geometry);
void setGeometry(uint32_t x, uint32_t y, uint32_t width, uint32_t height);
void move(const QPoint &pos);