mirror/flatpak
1
0
Fork 0
mirror of https://github.com/flatpak/flatpak.git synced 2026-02-01 03:21:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

Improve FlatpakInstallation docs

Browse Source 
Document the values returned by flatpak_installation_get_id()
and by flatpak_installation_get_display_name() for standard
installations.

Closes: #2583
Approved by: alexlarsson
This commit is contained in:
Matthias Clasen
2019-01-12 17:38:09 -05:00
committed by Atomic Bot
parent f7a566e2ab
commit faab490f1e
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
common/flatpak-installation.c
View File

@@ -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