diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2016-03-25 10:50:39 -0400 |
|---|---|---|
| committer | Matthias Clasen <mclasen@redhat.com> | 2016-03-25 11:03:22 -0400 |
| commit | 842fc72342ff54cba9a24fcb666bf4e47f6bbe50 (patch) | |
| tree | 2f173b2663fcaab3525c128c6f3857a0e85908a2 /lib | |
| parent | c18a0d7412a905733e03837a24a35344aaf3cd36 (diff) | |
| download | xdg-app-842fc72342ff54cba9a24fcb666bf4e47f6bbe50.tar.gz | |
XdgAppRemoteRef: Add documentation
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/xdg-app-remote-ref.c | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/lib/xdg-app-remote-ref.c b/lib/xdg-app-remote-ref.c index 19eb4b3..6b397db 100644 --- a/lib/xdg-app-remote-ref.c +++ b/lib/xdg-app-remote-ref.c @@ -27,6 +27,14 @@ #include "xdg-app-remote-ref.h" #include "xdg-app-enum-types.h" +/** + * SECTION:xdg-app-remote-ref + * @Title: XdgAppRemoteRef + * @Short_description: Remote application reference + * + * A XdgAppRemoteRef provides information about an application or runtime + * (in short: ref) that is available from a remote repository. + */ typedef struct _XdgAppRemoteRefPrivate XdgAppRemoteRefPrivate; struct _XdgAppRemoteRefPrivate @@ -108,8 +116,8 @@ xdg_app_remote_ref_class_init (XdgAppRemoteRefClass *klass) g_object_class_install_property (object_class, PROP_REMOTE_NAME, g_param_spec_string ("remote-name", - "", - "", + "Remote Name", + "The name of the remote", NULL, G_PARAM_READWRITE)); } @@ -119,6 +127,14 @@ xdg_app_remote_ref_init (XdgAppRemoteRef *self) { } +/** + * xdg_app_remote_ref_get_remote_name: + * @self: a #XdgAppRemoteRef + * + * Gets the remote name of the ref. + * + * Returns: (transfer none): the remote name + */ const char * xdg_app_remote_ref_get_remote_name (XdgAppRemoteRef *self) { |