all: use type/prop shorthand in docs

This commit is contained in:
outfoxxed 2024-07-14 16:17:51 -07:00
parent c4cc662bcc
commit e9cacbd92d
Signed by untrusted user: outfoxxed
GPG key ID: 4C88A185FB89301E
17 changed files with 38 additions and 63 deletions

View file

@ -25,7 +25,7 @@ class WlSessionLockSurface;
/// Wayland session lock implemented using the [ext_session_lock_v1] protocol.
///
/// WlSessionLock will create an instance of its `surface` component for every screen when
/// `locked` is set to true. The `surface` component must create a [WlSessionLockSurface]
/// `locked` is set to true. The `surface` component must create a @@WlSessionLockSurface
/// which will be displayed on each screen.
///
/// The below example will create a session lock that disappears when the button is clicked.
@ -53,7 +53,6 @@ class WlSessionLockSurface;
/// > but it will render it inoperable.
///
/// [ext_session_lock_v1]: https://wayland.app/protocols/ext-session-lock-v1
/// [WlSessionLockSurface]: ../wlsessionlocksurface
class WlSessionLock: public Reloadable {
Q_OBJECT;
// clang-format off
@ -66,9 +65,7 @@ class WlSessionLock: public Reloadable {
///
/// This is set to true once the compositor has confirmed all screens are covered with locks.
Q_PROPERTY(bool secure READ isSecure NOTIFY secureStateChanged);
/// The surface that will be created for each screen. Must create a [WlSessionLockSurface].
///
/// [WlSessionLockSurface]: ../wlsessionlocksurface
/// The surface that will be created for each screen. Must create a @@WlSessionLockSurface$.
Q_PROPERTY(QQmlComponent* surface READ surfaceComponent WRITE setSurfaceComponent NOTIFY surfaceComponentChanged);
// clang-format on
QML_ELEMENT;
@ -109,9 +106,7 @@ private:
};
///! Surface to display with a `WlSessionLock`.
/// Surface displayed by a [WlSessionLock] when it is locked.
///
/// [WlSessionLock]: ../wlsessionlock
/// Surface displayed by a @@WlSessionLock when it is locked.
class WlSessionLockSurface: public Reloadable {
Q_OBJECT;
// clang-format off

View file

@ -17,7 +17,7 @@ class ToplevelHandle;
///! Window from another application.
/// A window/toplevel from another application, retrievable from
/// the [ToplevelManager](../toplevelmanager).
/// the @@ToplevelManager$.
class Toplevel: public QObject {
Q_OBJECT;
Q_PROPERTY(QString appId READ appId NOTIFY appIdChanged);
@ -122,7 +122,7 @@ private:
};
///! Exposes a list of Toplevels.
/// Exposes a list of windows from other applications as [Toplevel](../toplevel)s via the
/// Exposes a list of windows from other applications as @@Toplevel$s via the
/// [zwlr-foreign-toplevel-management-v1](https://wayland.app/protocols/wlr-foreign-toplevel-management-unstable-v1)
/// wayland protocol.
class ToplevelManagerQml: public QObject {

View file

@ -16,7 +16,7 @@
/// Decorationless window that can be attached to the screen edges using the [zwlr_layer_shell_v1] protocol.
///
/// #### Attached property
/// `WlrLayershell` works as an attached property of [PanelWindow] which you should use instead if you can,
/// `WlrLayershell` works as an attached property of @@Quickshell.PanelWindow which you should use instead if you can,
/// as it is platform independent.
/// ```qml
/// PanelWindow {
@ -37,7 +37,6 @@
/// ```
///
/// [zwlr_layer_shell_v1]: https://wayland.app/protocols/wlr-layer-shell-unstable-v1
/// [PanelWindow]: ../../quickshell/panelwindow
class WlrLayershell: public ProxyWindowBase {
QSDOC_BASECLASS(PanelWindowInterface);
// clang-format off

View file

@ -41,7 +41,7 @@ enum Enum {
///
/// > [!WARNING] You **CANNOT** use this to make a secure lock screen.
/// >
/// > If you want to make a lock screen, use [WlSessionLock](../wlsessionlock).
/// > If you want to make a lock screen, use @@WlSessionLock$.
Exclusive = 1,
/// Access to the keyboard as determined by the operating system.
///