From d7eed4fd5275dfbc3adc6c93196966de7a14ca0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Mon, 26 Dec 2022 12:38:29 +0100 Subject: [PATCH 1/3] lfb-event: Fix docstring This allows gi-docgen to pick it up --- libfeedback/lfb-event.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libfeedback/lfb-event.c b/libfeedback/lfb-event.c index 48b026b..5d50bb8 100644 --- a/libfeedback/lfb-event.c +++ b/libfeedback/lfb-event.c @@ -11,8 +11,8 @@ /** * LfbEvent: - * @Short_description: An event triggering feedback to the user - * @Title: LfbEvent + * + * An event triggering feedback to the user * * #LfbEvent represents an event that should trigger * audio, haptic and/or visual feedback to the user by triggering From ae85ac15d59f6994cb9051ae3a3e422b0f44e3ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Wed, 4 Jan 2023 17:27:51 +0100 Subject: [PATCH 2/3] doc: Fix link to spec in manpage --- doc/fbcli.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/fbcli.rst b/doc/fbcli.rst index 8d439a2..4955579 100644 --- a/doc/fbcli.rst +++ b/doc/fbcli.rst @@ -28,7 +28,7 @@ OPTIONS ``-E=EVENT``; ``--event=EVENT`` Submit the given event to ``feedbackd``. Valid events are listes in the event naming spec at - `https://source.puri.sm/Librem5/feedbackd/-/blob/main/Event-naming-spec-0.0.0.md`__ + https://source.puri.sm/Librem5/feedbackd/-/blob/main/doc/Event-naming-spec-0.0.0.md ``-t=TIMEOUT``; ``--timeout=TIMEOUT`` The timeout in seconds after which feedback for the given event should From 88cc9a2d544159580fe9e22e5136a2e698b7db7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Wed, 4 Jan 2023 17:28:03 +0100 Subject: [PATCH 3/3] libfeedback: Fix link to specs Since we now have them as part of the API docs we can avoid any remote URLs --- libfeedback/lfb-event.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libfeedback/lfb-event.c b/libfeedback/lfb-event.c index 5d50bb8..0582bd0 100644 --- a/libfeedback/lfb-event.c +++ b/libfeedback/lfb-event.c @@ -18,7 +18,7 @@ * audio, haptic and/or visual feedback to the user by triggering * feedback on a feedback daemon. Valid event names are specified * in the - * [Event naming specification](https://source.puri.sm/Librem5/feedbackd/-/blob/main/Event-naming-spec-0.0.0.md). + * [Event naming specification](Event-naming-spec-0.0.0.html). * * One event can trigger multiple feedbacks at once (e.g. audio and * haptic feedback). This is determined by the feedback theme in @@ -695,7 +695,7 @@ lfb_event_get_end_reason (LfbEvent *self) * Tells the feedback server to use the given feedback profile for * this event when it is submitted. The server might ignore this * request. Valid profile names and their 'noisiness' are specified - * in the [Feedback theme specification](https://source.puri.sm/Librem5/feedbackd/-/blob/main/Feedback-theme-spec-0.0.0.md). + * in the [Feedback theme specification](Feedback-theme-spec-0.0.0.html). * * A value of %NULL (the default) lets the server pick the profile. */