[network-manager-applet/lr/gtk-doc: 1/4] libnma: add gtk-doc blocks here and there
- From: Lubomir Rintel <lkundrak src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [network-manager-applet/lr/gtk-doc: 1/4] libnma: add gtk-doc blocks here and there
- Date: Thu, 2 Mar 2017 15:36:44 +0000 (UTC)
commit ecbc4cf6db65ae7fc73d0f666f673d2b91ee6bfd
Author: Lubomir Rintel <lkundrak v3 sk>
Date: Thu Mar 2 16:09:58 2017 +0100
libnma: add gtk-doc blocks here and there
It doesn't really improve the documentation, but at least makes gtk-doc
happy.
src/libnma/nma-mobile-providers.c | 11 +++++++++++
src/libnma/nma-mobile-providers.h | 6 ++++++
src/libnma/nma-mobile-wizard.c | 7 +++++++
src/libnma/nma-mobile-wizard.h | 11 +++++++++++
4 files changed, 35 insertions(+), 0 deletions(-)
---
diff --git a/src/libnma/nma-mobile-providers.c b/src/libnma/nma-mobile-providers.c
index d6b44fd..a66b8eb 100644
--- a/src/libnma/nma-mobile-providers.c
+++ b/src/libnma/nma-mobile-providers.c
@@ -111,6 +111,7 @@ nma_mobile_access_method_unref (NMAMobileAccessMethod *method)
/**
* nma_mobile_access_method_get_name:
+ * @method: a #NMAMobileAccessMethod
*
* Returns: (transfer none): the name of the method.
*/
@@ -124,6 +125,7 @@ nma_mobile_access_method_get_name (NMAMobileAccessMethod *method)
/**
* nma_mobile_access_method_get_username:
+ * @method: a #NMAMobileAccessMethod
*
* Returns: (transfer none): the username.
*/
@@ -137,6 +139,7 @@ nma_mobile_access_method_get_username (NMAMobileAccessMethod *method)
/**
* nma_mobile_access_method_get_password:
+ * @method: a #NMAMobileAccessMethod
*
* Returns: (transfer none): the password.
*/
@@ -150,6 +153,7 @@ nma_mobile_access_method_get_password (NMAMobileAccessMethod *method)
/**
* nma_mobile_access_method_get_gateway:
+ * @method: a #NMAMobileAccessMethod
*
* Returns: (transfer none): the gateway.
*/
@@ -163,6 +167,7 @@ nma_mobile_access_method_get_gateway (NMAMobileAccessMethod *method)
/**
* nma_mobile_access_method_get_dns:
+ * @method: a #NMAMobileAccessMethod
*
* Returns: (transfer none) (array zero-terminated=1) (element-type utf8): the list of DNS.
*/
@@ -176,6 +181,7 @@ nma_mobile_access_method_get_dns (NMAMobileAccessMethod *method)
/**
* nma_mobile_access_method_get_3gpp_apn:
+ * @method: a #NMAMobileAccessMethod
*
* Returns: (transfer none): the 3GPP APN.
*/
@@ -189,6 +195,7 @@ nma_mobile_access_method_get_3gpp_apn (NMAMobileAccessMethod *method)
/**
* nma_mobile_access_method_get_family:
+ * @method: a #NMAMobileAccessMethod
*
* Returns: a #NMAMobileFamily.
*/
@@ -268,6 +275,7 @@ nma_mobile_provider_unref (NMAMobileProvider *provider)
/**
* nma_mobile_provider_get_name:
+ * @provider: a #NMAMobileProvider
*
* Returns: (transfer none): the name of the provider.
*/
@@ -378,6 +386,7 @@ nma_country_info_unref (NMACountryInfo *country_info)
/**
* nma_country_info_get_country_code:
+ * @country_info: a #NMACountryInfo
*
* Returns: (transfer none): the code of the country.
*/
@@ -391,6 +400,7 @@ nma_country_info_get_country_code (NMACountryInfo *country_info)
/**
* nma_country_info_get_country_name:
+ * @country_info: a #NMACountryInfo
*
* Returns: (transfer none): the name of the country.
*/
@@ -404,6 +414,7 @@ nma_country_info_get_country_name (NMACountryInfo *country_info)
/**
* nma_country_info_get_providers:
+ * @country_info: a #NMACountryInfo
*
* Returns: (element-type NMAMobileProvider) (transfer none): the
* list of #NMAMobileProvider this country exposes.
diff --git a/src/libnma/nma-mobile-providers.h b/src/libnma/nma-mobile-providers.h
index 4442d7f..46e39f3 100644
--- a/src/libnma/nma-mobile-providers.h
+++ b/src/libnma/nma-mobile-providers.h
@@ -36,6 +36,12 @@
/******************************************************************************/
/* Access method type */
+/**
+ * NMAMobileFamily:
+ * @NMA_MOBILE_FAMILY_UNKNOWN: Unknown or invalid network access method
+ * @NMA_MOBILE_FAMILY_3GPP: 3rd Generation Partnership Project (3GPP) network
+ * @NMA_MOBILE_FAMILY_CDMA: A CDMA network
+ */
typedef enum {
NMA_MOBILE_FAMILY_UNKNOWN = 0,
NMA_MOBILE_FAMILY_3GPP,
diff --git a/src/libnma/nma-mobile-wizard.c b/src/libnma/nma-mobile-wizard.c
index a035c8d..f103c24 100644
--- a/src/libnma/nma-mobile-wizard.c
+++ b/src/libnma/nma-mobile-wizard.c
@@ -1565,7 +1565,14 @@ get_country_from_locale (void)
/**
* nma_mobile_wizard_new: (skip)
+ * @parent:
+ * @window_group:
+ * @modem_caps:
+ * @will_connect_after:
* @cb: (scope async):
+ * @user_data:
+ *
+ * Returns: the newly created #NMAMobileWizard
*/
NMAMobileWizard *
nma_mobile_wizard_new (GtkWindow *parent,
diff --git a/src/libnma/nma-mobile-wizard.h b/src/libnma/nma-mobile-wizard.h
index 5f626f6..24fe7b8 100644
--- a/src/libnma/nma-mobile-wizard.h
+++ b/src/libnma/nma-mobile-wizard.h
@@ -33,6 +33,17 @@
typedef struct NMAMobileWizard NMAMobileWizard;
+/**
+ * NMAMobileWizardAccessMethod:
+ * @provider_name: The mobile network provider name
+ * @plan_name: The provided network access billing plan
+ * @devtype: Required NetworkManager device capabilities
+ * @username: User login
+ * @password: User secret
+ * @gsm_apn: The GSM Access Point Name
+ *
+ * Network access method details.
+ */
typedef struct {
char *provider_name;
char *plan_name;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]