From faab490f1eece2184dc8c895b2394293ee5b45dd Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 12 Jan 2019 17:38:09 -0500 Subject: [PATCH] Improve FlatpakInstallation docs Document the values returned by flatpak_installation_get_id() and by flatpak_installation_get_display_name() for standard installations. Closes: #2583 Approved by: alexlarsson --- common/flatpak-installation.c | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/common/flatpak-installation.c b/common/flatpak-installation.c index 46d567e9..0377e910 100644 --- a/common/flatpak-installation.c +++ b/common/flatpak-installation.c @@ -63,7 +63,7 @@ * To get a list of all configured installations, use flatpak_get_system_installations(), * together with flatpak_installation_new_user(). * - * The FlatpakInstallatio nAPI is threadsafe in the sense that it is safe to run two + * The FlatpakInstallation API is threadsafe in the sense that it is safe to run two * operations at the same time, in different threads (or processes). */ @@ -500,6 +500,9 @@ flatpak_installation_get_path (FlatpakInstallation *self) * * Returns the ID of the installation for @self. * + * The ID for the default system installation is "default". + * The ID for the user installation is "user". + * * Returns: (transfer none): a string with the installation's ID * * Since: 0.8 @@ -518,6 +521,9 @@ flatpak_installation_get_id (FlatpakInstallation *self) * * Returns the display name of the installation for @self. * + * Note that this function may return %NULL if the installation + * does not have a display name. + * * Returns: (transfer none): a string with the installation's display name * * Since: 0.8