luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-28 16:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix KeyFile annotations

Browse Source 
Use the right gtk-doc sigil for pre-processor symbols.

Reduce the indentation in argument annotations, to avoid them being
parsed as code blocks.
This commit is contained in:
Emmanuele Bassi 2021-08-02 15:55:08 +01:00
parent 1b666b7f12
commit 3b5d3ed2e3
1 changed files with 39 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
glib/gkeyfile.c
View File

@ -257,11 +257,12 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_TYPE: * G_KEY_FILE_DESKTOP_KEY_TYPE:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string
* giving the type of the desktop entry. Usually * giving the type of the desktop entry.
* #G_KEY_FILE_DESKTOP_TYPE_APPLICATION, *
* #G_KEY_FILE_DESKTOP_TYPE_LINK, or * Usually %G_KEY_FILE_DESKTOP_TYPE_APPLICATION,
* #G_KEY_FILE_DESKTOP_TYPE_DIRECTORY. * %G_KEY_FILE_DESKTOP_TYPE_LINK, or
* %G_KEY_FILE_DESKTOP_TYPE_DIRECTORY.
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -269,7 +270,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_VERSION: * G_KEY_FILE_DESKTOP_KEY_VERSION:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string
* giving the version of the Desktop Entry Specification used for * giving the version of the Desktop Entry Specification used for
* the desktop entry file. * the desktop entry file.
* *
@ -279,7 +280,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_NAME: * G_KEY_FILE_DESKTOP_KEY_NAME:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a localized
* string giving the specific name of the desktop entry. * string giving the specific name of the desktop entry.
* *
* Since: 2.14 * Since: 2.14
@ -288,7 +289,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME: * G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a localized
* string giving the generic name of the desktop entry. * string giving the generic name of the desktop entry.
* *
* Since: 2.14 * Since: 2.14
@ -297,7 +298,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY: * G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
* stating whether the desktop entry should be shown in menus. * stating whether the desktop entry should be shown in menus.
* *
* Since: 2.14 * Since: 2.14
@ -306,7 +307,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_COMMENT: * G_KEY_FILE_DESKTOP_KEY_COMMENT:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a localized
* string giving the tooltip for the desktop entry. * string giving the tooltip for the desktop entry.
* *
* Since: 2.14 * Since: 2.14
@ -315,7 +316,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_ICON: * G_KEY_FILE_DESKTOP_KEY_ICON:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a localized
* string giving the name of the icon to be displayed for the desktop * string giving the name of the icon to be displayed for the desktop
* entry. * entry.
* *
@ -325,7 +326,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_HIDDEN: * G_KEY_FILE_DESKTOP_KEY_HIDDEN:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
* stating whether the desktop entry has been deleted by the user. * stating whether the desktop entry has been deleted by the user.
* *
* Since: 2.14 * Since: 2.14
@ -334,7 +335,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN: * G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a list of
* strings identifying the environments that should display the * strings identifying the environments that should display the
* desktop entry. * desktop entry.
* *
@ -344,7 +345,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN: * G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a list of
* strings identifying the environments that should not display the * strings identifying the environments that should not display the
* desktop entry. * desktop entry.
* *
@ -354,7 +355,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_TRY_EXEC: * G_KEY_FILE_DESKTOP_KEY_TRY_EXEC:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string
* giving the file name of a binary on disk used to determine if the * giving the file name of a binary on disk used to determine if the
* program is actually installed. It is only valid for desktop entries * program is actually installed. It is only valid for desktop entries
* with the `Application` type. * with the `Application` type.
@ -365,7 +366,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_EXEC: * G_KEY_FILE_DESKTOP_KEY_EXEC:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string
* giving the command line to execute. It is only valid for desktop * giving the command line to execute. It is only valid for desktop
* entries with the `Application` type. * entries with the `Application` type.
* *
@ -375,7 +376,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_PATH: * G_KEY_FILE_DESKTOP_KEY_PATH:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string
* containing the working directory to run the program in. It is only * containing the working directory to run the program in. It is only
* valid for desktop entries with the `Application` type. * valid for desktop entries with the `Application` type.
* *
@ -385,10 +386,10 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_TERMINAL: * G_KEY_FILE_DESKTOP_KEY_TERMINAL:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
* stating whether the program should be run in a terminal window. * stating whether the program should be run in a terminal window.
* It is only valid for desktop entries with the *
* `Application` type. * It is only valid for desktop entries with the `Application` type.
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -396,7 +397,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_MIME_TYPE: * G_KEY_FILE_DESKTOP_KEY_MIME_TYPE:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a list
* of strings giving the MIME types supported by this desktop entry. * of strings giving the MIME types supported by this desktop entry.
* *
* Since: 2.14 * Since: 2.14
@ -405,7 +406,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_CATEGORIES: * G_KEY_FILE_DESKTOP_KEY_CATEGORIES:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a list
* of strings giving the categories in which the desktop entry * of strings giving the categories in which the desktop entry
* should be shown in a menu. * should be shown in a menu.
* *
@ -415,7 +416,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY: * G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
* stating whether the application supports the * stating whether the application supports the
* [Startup Notification Protocol Specification](http://www.freedesktop.org/Standards/startup-notification-spec). * [Startup Notification Protocol Specification](http://www.freedesktop.org/Standards/startup-notification-spec).
* *
@ -425,7 +426,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS: * G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is string * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is string
* identifying the WM class or name hint of a window that the application * identifying the WM class or name hint of a window that the application
* will create, which can be used to emulate Startup Notification with * will create, which can be used to emulate Startup Notification with
* older applications. * older applications.
@ -436,7 +437,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_URL: * G_KEY_FILE_DESKTOP_KEY_URL:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string
* giving the URL to access. It is only valid for desktop entries * giving the URL to access. It is only valid for desktop entries
* with the `Link` type. * with the `Link` type.
* *
@ -446,8 +447,8 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE: * G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean set to true * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
* if the application is D-Bus activatable. * set to true if the application is D-Bus activatable.
* *
* Since: 2.38 * Since: 2.38
*/ */
@ -455,7 +456,7 @@
/** /**
* G_KEY_FILE_DESKTOP_KEY_ACTIONS: * G_KEY_FILE_DESKTOP_KEY_ACTIONS:
* *
* A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string list * A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string list
* giving the available application actions. * giving the available application actions.
* *
* Since: 2.38 * Since: 2.38
@ -464,7 +465,7 @@
/** /**
* G_KEY_FILE_DESKTOP_TYPE_APPLICATION: * G_KEY_FILE_DESKTOP_TYPE_APPLICATION:
* *
* The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop * The value of the %G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop
* entries representing applications. * entries representing applications.
* *
* Since: 2.14 * Since: 2.14
@ -473,7 +474,7 @@
/** /**
* G_KEY_FILE_DESKTOP_TYPE_LINK: * G_KEY_FILE_DESKTOP_TYPE_LINK:
* *
* The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop * The value of the %G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop
* entries representing links to documents. * entries representing links to documents.
* *
* Since: 2.14 * Since: 2.14
@ -482,7 +483,7 @@
/** /**
* G_KEY_FILE_DESKTOP_TYPE_DIRECTORY: * G_KEY_FILE_DESKTOP_TYPE_DIRECTORY:
* *
* The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop * The value of the %G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop
* entries representing directories. * entries representing directories.
* *
* Since: 2.14 * Since: 2.14