From 00e5a0d325c36f2593f342d8e362dcc8d8a4b426 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Wed, 23 Aug 2017 16:55:02 +0100 Subject: [PATCH] lib/remote: Add documentation for the class properties Signed-off-by: Philip Withnall --- lib/flatpak-remote.c | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/lib/flatpak-remote.c b/lib/flatpak-remote.c index 2b70d4a66..403382a54 100644 --- a/lib/flatpak-remote.c +++ b/lib/flatpak-remote.c @@ -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",