marko10_000
/
flatpak-builder
forked from Mirrors/flatpak-builder
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

lib/remote: Add documentation for the class properties 

Signed-off-by: Philip Withnall <withnall@endlessm.com>
tingping/wmclass
Philip Withnall 2017-08-23 16:55:02 +01:00
parent 706d13895e
commit 00e5a0d325
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
lib/flatpak-remote.c
View File

@ -171,6 +171,14 @@ flatpak_remote_class_init (FlatpakRemoteClass *klass)
object_class->set_property = flatpak_remote_set_property;
object_class->finalize = flatpak_remote_finalize;
/**
* FlatpakRemote:name:
*
* Name of the remote, as used in configuration files and when interfacing
* with OSTree. This is typically human readable, but could be generated, and
* must conform to ostree_validate_remote_name(). It should typically not be
* presented in the UI.
*/
g_object_class_install_property (object_class,
PROP_NAME,
g_param_spec_string ("name",
@ -179,6 +187,17 @@ flatpak_remote_class_init (FlatpakRemoteClass *klass)
NULL,
G_PARAM_READWRITE));
/**
* FlatpakRemote:type:
*
* The type of the remote: whether it comes from static configuration files
* (@FLATPAK_REMOTE_TYPE_STATIC) or has been dynamically found from the local
* network or a mounted USB drive (@FLATPAK_REMOTE_TYPE_LAN,
* @FLATPAK_REMOTE_TYPE_USB). Dynamic remotes may be added and removed over
* time.
*
* Since: 0.9.8
*/
g_object_class_install_property (object_class,
PROP_TYPE,
g_param_spec_enum ("type",