diff options
authorYuri Chornoivan <[email protected]>2019-01-13 09:22:11 +0200
committerYuri Chornoivan <[email protected]>2019-01-13 09:22:11 +0200
commitd08950feead435be5af258dc75226b92c789610b (patch)
parent7934c03ac22a3018240232b5835a401a644fb054 (diff)
Fix minor Doxygen issues
3 files changed, 10 insertions, 7 deletions
diff --git a/abstract_client.h b/abstract_client.h
index ca4efa0..8a97374 100644
--- a/abstract_client.h
+++ b/abstract_client.h
@@ -591,6 +591,7 @@ public:
/** Set the quick tile mode ("snap") of this window.
* This will also handle preserving and restoring of window geometry as necessary.
* @param mode The tile mode (left/right) to give this window.
+ * @param keyboard Defines whether to take keyboard cursor into account.
void setQuickTileMode(QuickTileMode mode, bool keyboard = false);
QuickTileMode quickTileMode() const {
@@ -758,13 +759,13 @@ public:
* Default implementation returns @c null.
* Mostly intended for X11 clients, from EWMH:
- * <quote>
+ * @verbatim
* If the WM_TRANSIENT_FOR property is set to None or Root window, the window should be
* treated as a transient for all other windows in the same group. It has been noted that this
* is a slight ICCCM violation, but as this behavior is pretty standard for many toolkits and
* window managers, and is extremely unlikely to break anything, it seems reasonable to document
* it as standard.
- * </quote>
+ * @endverbatim
virtual bool groupTransient() const;
@@ -1121,7 +1122,7 @@ protected:
virtual void updateCaption() = 0;
- * Looks for another AbstractClient with same @link{captionNormal} and @link{captionSuffix}.
+ * Looks for another AbstractClient with same captionNormal and captionSuffix.
* If no such AbstractClient exists @c nullptr is returned.
AbstractClient *findClientWithSameCaption() const;
diff --git a/libkwineffects/kwineffects.h b/libkwineffects/kwineffects.h
index fbeae78..1713c2b 100644
--- a/libkwineffects/kwineffects.h
+++ b/libkwineffects/kwineffects.h
@@ -855,9 +855,10 @@ public:
* No window will get the mouse events. Only fullscreen effects providing a custom user interface should
* be using this method. The input events are delivered to Effect::windowInputMouseEvent.
- * NOTE: this method does not perform an X11 mouse grab. On X11 a fullscreen input window is raised above
+ * @note This method does not perform an X11 mouse grab. On X11 a fullscreen input window is raised above
* all other windows, but no grab is performed.
+ * @param effect The effect
* @param shape Sets the cursor to be used while the mouse is intercepted
* @see stopMouseInterception
* @see Effect::windowInputMouseEvent
@@ -1394,7 +1395,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
- * @ref EffectWindow::refWindow
+ * refWindow
* @param w The window which is being closed
* @since 4.7
@@ -1420,7 +1421,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
- * @ref EffectWindow::isUserMove or @ref EffectWindow::isUserResize.
+ * isUserMove or isUserResize.
* Whenever the geometry is updated the signal @ref windowStepUserMovedResized
* is emitted with the current geometry.
* The move/resize operation ends with the signal @ref windowFinishUserMovedResized.
diff --git a/screenedge.h b/screenedge.h
index a14e9dc..5255d0d 100644
--- a/screenedge.h
+++ b/screenedge.h
@@ -185,7 +185,7 @@ private:
* edge. The idea is to not block the screen edge if nothing could be triggered there, so that the
* user e.g. can configure nothing on the top edge, which tends to interfere with full screen apps
* having a hidden panel there. On X11 (currently only supported backend) the @ref Edge is
- * represented by a @ref WindowBasedEdge which creates an input only window for the geometry and
+ * represented by a WindowBasedEdge which creates an input only window for the geometry and
* reacts on enter notify events. If the edge gets reserved for the first time a window is created
* and mapped, once the edge gets unreserved again, the window gets destroyed.
@@ -305,6 +305,7 @@ public:
* Reserve desktop switching for screen edges, if @p isToReserve is @c true. Unreserve otherwise.
* @param isToReserve indicated whether desktop switching should be reserved or unreseved
+ * @param o Qt orientations
void reserveDesktopSwitching(bool isToReserve, Qt::Orientations o);