[libcloudproviders/wip/documentation-update: 5/7] docs: extend documentation of CloudProviderAccount



commit 4728c46b569694666636a21510adf19b46f1991f
Author: Julius Härtl <jus bitgrid net>
Date:   Mon Sep 4 12:24:20 2017 +0200

    docs: extend documentation of CloudProviderAccount

 src/cloudprovideraccount.c | 50 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
---
diff --git a/src/cloudprovideraccount.c b/src/cloudprovideraccount.c
index d2a6ed3..c58d368 100644
--- a/src/cloudprovideraccount.c
+++ b/src/cloudprovideraccount.c
@@ -379,6 +379,12 @@ cloud_provider_account_init (CloudProviderAccount *self)
   priv->status = CLOUD_PROVIDER_STATUS_INVALID;
 }
 
+/**
+ * cloud_provider_account_get_name:
+ * @self: A cloud provider account
+ *
+ * Returns: The name of the cloud provider account
+ */
 gchar*
 cloud_provider_account_get_name (CloudProviderAccount *self)
 {
@@ -387,6 +393,12 @@ cloud_provider_account_get_name (CloudProviderAccount *self)
   return priv->name;
 }
 
+/**
+ * cloud_provider_account_get_status:
+ * @self: A cloud provider account
+ *
+ * Returns: The status of the cloud provider account
+ */
 CloudProviderStatus
 cloud_provider_account_get_status (CloudProviderAccount *self)
 {
@@ -395,6 +407,12 @@ cloud_provider_account_get_status (CloudProviderAccount *self)
   return priv->status;
 }
 
+/**
+ * cloud_provider_account_get_status_details:
+ * @self: A cloud provider account
+ *
+ * Returns: The status detail description of the cloud provider account
+ */
 gchar*
 cloud_provider_account_get_status_details (CloudProviderAccount *self)
 {
@@ -403,6 +421,12 @@ cloud_provider_account_get_status_details (CloudProviderAccount *self)
   return priv->status_details;
 }
 
+/**
+ * cloud_provider_account_get_icon:
+ * @self: A cloud provider account
+ *
+ * Returns: The icon of the cloud provider account
+ */
 GIcon*
 cloud_provider_account_get_icon (CloudProviderAccount *self)
 {
@@ -411,6 +435,12 @@ cloud_provider_account_get_icon (CloudProviderAccount *self)
   return priv->icon;
 }
 
+/**
+ * cloud_provider_account_get_menu_model:
+ * @self: A cloud provider account
+ *
+ * Returns: The menu model exported by the cloud provider account
+ */
 GMenuModel*
 cloud_provider_account_get_menu_model (CloudProviderAccount *self)
 {
@@ -419,6 +449,12 @@ cloud_provider_account_get_menu_model (CloudProviderAccount *self)
   return priv->menu_model;
 }
 
+/**
+ * cloud_provider_account_get_action_group:
+ * @self: A cloud provider account
+ *
+ * Returns: The action group exported by the cloud provider account
+ */
 GActionGroup*
 cloud_provider_account_get_action_group (CloudProviderAccount *self)
 {
@@ -427,6 +463,12 @@ cloud_provider_account_get_action_group (CloudProviderAccount *self)
   return priv->action_group;
 }
 
+/**
+ * cloud_provider_account_get_path:
+ * @self: A cloud provider account
+ *
+ * Returns: The directory path of the cloud provider account
+ */
 gchar *
 cloud_provider_account_get_path (CloudProviderAccount *self)
 {
@@ -443,6 +485,14 @@ cloud_provider_account_get_owner (CloudProviderAccount *self)
    return g_dbus_proxy_get_name_owner (G_DBUS_PROXY(priv->proxy));
 }
 
+/**
+ * cloud_provider_account_is_available:
+ * @self: A cloud provider account
+ *
+ * Check if the account is ready to be used. This will check if name, icon, status
+ * and path are set since it cannot be garantued otherwise during startup of the
+ * cloud provider client.
+ */
 gboolean cloud_provider_account_is_available(CloudProviderAccount *self)
 {
   GIcon *icon;


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]