[gnome-software/wip/fix-gtkdoc-for-gs_app_get_unique_id] gs-app: Fix developer comment for gs_app_get_unique_id()
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-software/wip/fix-gtkdoc-for-gs_app_get_unique_id] gs-app: Fix developer comment for gs_app_get_unique_id()
- Date: Tue, 7 Jun 2022 16:51:18 +0000 (UTC)
commit 958cef35579ab12e1b62494b50a3057d66e1ed02
Author: Milan Crha <mcrha redhat com>
Date: Tue Jun 7 18:47:54 2022 +0200
gs-app: Fix developer comment for gs_app_get_unique_id()
The gtk-doc is failing when parsing gs-app.xml due to opening and closing
elements do not match. Escape the <> properly to avoid the problem.
The asterisk in the text around forward slash is also problematic, and
the backslash escaping doesn't work here, as the backslash makes it into
the generated HTML, thus use a different example unique ID.
lib/gs-app.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/lib/gs-app.c b/lib/gs-app.c
index 26eaa9c6e..122f915a0 100644
--- a/lib/gs-app.c
+++ b/lib/gs-app.c
@@ -1423,12 +1423,12 @@ gs_app_set_kind (GsApp *app, AsComponentKind kind)
*
* Gets the unique application ID used for de-duplication.
*
- * The format is "<scope>/<kind>/<origin>/<id>/<branch>". Any unset fields will
+ * The format is "<scope>/<kind>/<origin>/<id>/<branch>". Any unset fields will
* appear as "*". This string can be used with libappstream's functions for
* handling data IDs, e.g.
* https://www.freedesktop.org/software/appstream/docs/api/appstream-as-utils.html#as-utils-data-id-valid
*
- * Returns: The unique ID, e.g. `user/fedora/\*\/gimp.desktop/\*`, or %NULL
+ * Returns: The unique ID, e.g. `system/flatpak/flathub/org.gnome.Notes/stable`, or %NULL
*
* Since: 3.22
**/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]