Commit c4ba4bd5 authored by Friedrich W. H. Kossebau's avatar Friedrich W. H. Kossebau
Browse files

API dox: fix @link usage

@link either needs a matching @endlink tag,
or being used in javadoc style, {@link target [label]}
parent 7d10af91
......@@ -140,7 +140,7 @@ public:
/**
* Informs the PlasmaShellSurfaceInterface that the auto-hiding panel got hidden.
* Once it is shown again the method @link{showAutoHidingPanel} should be used.
* Once it is shown again the method {@link showAutoHidingPanel} should be used.
*
* @see showAutoHidingPanel
* @see panelAutoHideHideRequested
......@@ -197,9 +197,9 @@ Q_SIGNALS:
* A surface with Role Panel and PanelBehavior AutoHide requested to be hidden.
*
* The compositor should inform the PlasmaShellSurfaceInterface about the actual change.
* Once the surface is hidden it should invoke @link{hideAutoHidingPanel}. If the compositor
* Once the surface is hidden it should invoke {@link hideAutoHidingPanel}. If the compositor
* cannot hide the surface (e.g. because it doesn't border a screen edge) it should inform
* the surface through invoking @link{showAutoHidingPanel}. This method should also be invoked
* the surface through invoking {@link showAutoHidingPanel}. This method should also be invoked
* whenever the surface gets shown again due to triggering the screen edge.
*
* @see hideAutoHidingPanel
......@@ -213,7 +213,7 @@ Q_SIGNALS:
* A surface with Role Panel and PanelBehavior AutoHide requested to be shown.
*
* The compositor should inform the PlasmaShellSurfaceInterface about the actual change.
* Once the surface is shown it should invoke @link{showAutoHidingPanel}.
* Once the surface is shown it should invoke {@link showAutoHidingPanel}.
*
* @see hideAutoHidingPanel
* @see showAutoHidingPanel
......
......@@ -53,8 +53,8 @@ public:
QList<PlasmaWindowInterface*> windows() const;
/**
* Unmaps the @p window previously created with @link{createWindow}.
* The window will be unmapped and removed from the list of @link{windows}.
* Unmaps the @p window previously created with {@link createWindow}.
* The window will be unmapped and removed from the list of {@link windows}.
*
* Unmapping a @p window indicates to the client that it should destroy the
* resource created for the window. Once all resources for the @p window are
......@@ -134,7 +134,7 @@ public:
* This method removes the Window and the Client is supposed to release the resource
* bound for this Window. Once all resources are released the Window gets deleted.
*
* Prefer using @link{PlasmaWindowManagementInterface::unmapWindow}.
* Prefer using {@link PlasmaWindowManagementInterface::unmapWindow}.
* @see PlasmaWindowManagementInterface::unmapWindow
**/
void unmap();
......
......@@ -387,7 +387,7 @@ public:
* and configuration-specific and non-accelerated deltas and accelerated
* deltas may have the same value on some devices.
*
* Relative motions are not coupled to wl_pointer.motion events (see @link{setPointerPos},
* Relative motions are not coupled to wl_pointer.motion events (see {@link setPointerPos},
* and can be sent in combination with such events, but also independently. There may
* also be scenarios where wl_pointer.motion is sent, but there is no
* relative motion. The order of an absolute and relative motion event
......@@ -624,7 +624,7 @@ public:
* The currently focused text input, may be @c null even if there is a
* focused text input surface set.
*
* The focused text input might not be enabled for the @link{focusedTextInputSurface}.
* The focused text input might not be enabled for the {@link focusedTextInputSurface}.
* It is recommended to check the enabled state before interacting with the
* TextInputInterface.
*
......
......@@ -50,7 +50,7 @@ enum class PointerConstraintsInterfaceVersion {
/**
* Manager object to create pointer constraints.
*
* To create this manager use @link{Display::createPointerConstraints}
* To create this manager use {@link Display::createPointerConstraints}
*
* @see ConfinedPointerInterface
* @see LockedPointerInterface
......@@ -82,9 +82,9 @@ private:
* to a position.
*
* It is up to the compositor whether the lock gets activated.
* To activate it needs to use @link{LockedPointerInterface::setLocked}.
* To activate it needs to use {@link LockedPointerInterface::setLocked}.
* The compositor needs to ensure that the SurfaceInterface has pointer focus
* and that the pointer is inside the @link{LockedPointerInterface::region} when
* and that the pointer is inside the {@link LockedPointerInterface::region} when
* it activates the lock.
*
* While the lock is active the PointerInterface does no longer emit pointer motion
......@@ -136,7 +136,7 @@ public:
*
* A pointer lock can only be activated if the SurfaceInterface
* this LockedPointerInterface was created for has pointer focus
* and the pointer is inside the @link{region}.
* and the pointer is inside the {@link region}.
*
* @param locked Whether the lock should be active
* @see isLocked
......@@ -153,7 +153,7 @@ Q_SIGNALS:
void regionChanged();
/**
* Emitted whenever the @link{isLocked} state changes.
* Emitted whenever the {@link isLocked} state changes.
* @see isLocked
* @see setLocked
**/
......@@ -175,14 +175,14 @@ private:
* pointer to a region of the SurfaceInterface.
*
* It is up to the compositor whether the confinement gets activated.
* To activate it needs to use @link{ConfinedPointerInterface::setConfined}.
* To activate it needs to use {@link ConfinedPointerInterface::setConfined}.
* The compositor needs to ensure that the SurfaceInterface has pointer focus
* and that the pointer is inside the @link{ConfinedPointerInterface::region} when
* and that the pointer is inside the {@link ConfinedPointerInterface::region} when
* it activates the confinement.
*
* From client side the confinement gets deactivated by destroying the ConfinedPointerInterface.
* From compositor side the confinement can be deactivated by setting
* @link{ConfinedPointerInterface::setConfined} to @c false.
* {@link ConfinedPointerInterface::setConfined} to @c false.
*
* @since 5.29
**/
......@@ -230,7 +230,7 @@ public:
*
* A pointer confinement can only be activated if the SurfaceInterface
* this ConfinedPointerInterface was created for has pointer focus
* and the pointer is inside the @link{region}.
* and the pointer is inside the {@link region}.
*
* @param confined Whether the confinement should be active
* @see isConfined
......@@ -247,7 +247,7 @@ Q_SIGNALS:
void regionChanged();
/**
* Emitted whenever the @link{isConfined} state changes.
* Emitted whenever the {@link isConfined} state changes.
* @see isConfined
* @see setConfined
**/
......
......@@ -59,9 +59,9 @@ enum class TextInputInterfaceVersion {
* @brief Represent the Global for the interface.
*
* The class can represent different interfaces. Which concrete interface is represented
* can be determined through @link{interfaceVersion}.
* can be determined through {@link interfaceVersion}.
*
* To create a TextInputManagerInterface use @link{Display::createTextInputManager}
* To create a TextInputManagerInterface use {@link Display::createTextInputManager}
*
* @since 5.23
**/
......@@ -91,9 +91,9 @@ private:
* for any interface which implements a text input, e.g. the unstable wl_text_input interface.
*
* It does not expose the actual interface to cover up the fact that the interface is unstable
* and might change. If one needs to know the actual used protocol, use the method @link{interfaceVersion}.
* and might change. If one needs to know the actual used protocol, use the method {@link interfaceVersion}.
*
* A TextInputInterface gets created by the @link{TextInputManagerInterface}. The individual
* A TextInputInterface gets created by the {@link TextInputManagerInterface}. The individual
* instances are not exposed directly. The SeatInterface provides access to the currently active
* TextInputInterface. This is evaluated automatically based on which SurfaceInterface has
* keyboard focus.
......@@ -256,13 +256,13 @@ public:
**/
QByteArray surroundingText() const;
/**
* @returns The byte offset of current cursor position within the @link {surroundingText}
* @returns The byte offset of current cursor position within the {@link surroundingText}
* @see surroundingText
* @see surroundingTextChanged
**/
qint32 surroundingTextCursorPosition() const;
/**
* The byte offset of the selection anchor within the @link{surroundingText}.
* The byte offset of the selection anchor within the {@link surroundingText}.
*
* If there is no selected text this is the same as cursor.
* @return The byte offset of the selection anchor
......@@ -303,9 +303,9 @@ public:
/**
* Notify when @p text should be inserted into the editor widget.
* The text to commit could be either just a single character after a key press or the
* result of some composing (@link{preEdit}). It could be also an empty text
* when some text should be removed (see @link{deleteSurroundingText}) or when
* the input cursor should be moved (see @link{cursorPosition}).
* result of some composing ({@link preEdit}). It could be also an empty text
* when some text should be removed (see {@link deleteSurroundingText}) or when
* the input cursor should be moved (see {@link cursorPosition}).
*
* Any previously set composing text should be removed.
* @param text The utf8-encoded text to be inserted into the editor widget
......@@ -318,7 +318,7 @@ public:
* Sets the cursor position inside the composing text (as byte offset) relative to the
* start of the composing text. When @p index is a negative number no cursor is shown.
*
* The Client applies the @p index together with @link{preEdit}.
* The Client applies the @p index together with {@link preEdit}.
* @param index The cursor position relative to the start of the composing text
* @see preEdit
**/
......@@ -393,14 +393,14 @@ Q_SIGNALS:
**/
void cursorRectangleChanged(const QRect &rect);
/**
* Emitted when the @link{contentPurpose} and/or @link{contentHints} changes.
* Emitted when the {@link contentPurpose} and/or {@link contentHints} changes.
* @see contentPurpose
* @see contentHints
**/
void contentTypeChanged();
/**
* Emitted when the @link{surroundingText}, @link{surroundingTextCursorPosition}
* and/or @link{surroundingTextSelectionAnchor} changed.
* Emitted when the {@link surroundingText}, {@link surroundingTextCursorPosition}
* and/or {@link surroundingTextSelectionAnchor} changed.
* @see surroundingText
* @see surroundingTextCursorPosition
* @see surroundingTextSelectionAnchor
......
......@@ -72,7 +72,7 @@ public:
/**
* Whether this SubSurfaceInterface is in synchronized mode.
* A SubSurface is in synchronized mode if either @link mode is
* A SubSurface is in synchronized mode if either {@link mode} is
* @c Mode::Synchronized or if the parent surface is in synchronized
* mode. If a SubSurfaceInterface is in synchronized mode all child
* SubSurfaceInterfaces are also in synchronized mode ignoring the actual mode.
......
......@@ -169,16 +169,16 @@ public:
bool isMapped() const;
/**
* Returns the tracked damage since the last call to @link resetTrackedDamage.
* In contrast to @link damage this method does not reset the damage when
* Returns the tracked damage since the last call to {@link resetTrackedDamage}.
* In contrast to {@link damage} this method does not reset the damage when
* a new BufferInterface gets committed. This allows a compositor to properly
* track the damage over multiple commits even if it didn't render each new
* BufferInterface.
*
* The damage gets reset whenever @link resetTrackedDamage is called.
* The damage gets reset whenever {@link resetTrackedDamage} is called.
* This allows a compositor to properly track the change in its rendering scene
* for this SurfaceInterface. After it updates its internal state (e.g. by creating
* an OpenGL texture from the BufferInterface) it can invoke @link resetTrackedDamage
* an OpenGL texture from the BufferInterface) it can invoke {@link resetTrackedDamage}
* and the damage tracker will start to track further damage changes.
*
* @returns Combined damage since last call to resetTrackedDamage
......
......@@ -138,7 +138,7 @@ public:
* This tells the Surface the current @p states it is in and the @p size it should have.
* If @p size has width and height at @c 0, the Surface can choose the size.
*
* The Surface acknowledges the configure event with @link{configureAcknowledged}.
* The Surface acknowledges the configure event with {@link configureAcknowledged}.
*
* @param states The states the surface is in
* @param size The requested size
......
Supports Markdown
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