diff options
| author | Tambet Ingo <tambet@gmail.com> | 2008-08-12 12:59:33 +0000 |
|---|---|---|
| committer | Tambet Ingo <tambet@gmail.com> | 2008-08-12 12:59:33 +0000 |
| commit | 0dfa8e9cafa75f3ea3b8d9449a7b065edb45bf00 (patch) | |
| tree | 4eea293ad19d7d9dcf734b111ff0c1980d2ad5be /libnm-glib/nm-dhcp4-config.c | |
| parent | df2021b7890ab1a9af123634d9b0767fc632e1f1 (diff) | |
| download | NetworkManager-0dfa8e9cafa75f3ea3b8d9449a7b065edb45bf00.tar.gz | |
2008-08-12 Tambet Ingo <tambet@gmail.com>
* libnm-glib/*.c. Document some more.
git-svn-id: http://svn-archive.gnome.org/svn/NetworkManager/trunk@3934 4912f4e0-d625-0410-9fb7-b9a5a253dbdc
Diffstat (limited to 'libnm-glib/nm-dhcp4-config.c')
| -rw-r--r-- | libnm-glib/nm-dhcp4-config.c | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/libnm-glib/nm-dhcp4-config.c b/libnm-glib/nm-dhcp4-config.c index 742bbe8812..a01be523c2 100644 --- a/libnm-glib/nm-dhcp4-config.c +++ b/libnm-glib/nm-dhcp4-config.c @@ -139,6 +139,12 @@ nm_dhcp4_config_class_init (NMDHCP4ConfigClass *config_class) object_class->finalize = finalize; /* properties */ + + /** + * NMDHCP4Config:options: + * + * The #GHashTable containing options of the configuration. + **/ g_object_class_install_property (object_class, PROP_OPTIONS, g_param_spec_boxed (NM_DHCP4_CONFIG_OPTIONS, @@ -148,6 +154,15 @@ nm_dhcp4_config_class_init (NMDHCP4ConfigClass *config_class) G_PARAM_READABLE)); } +/** + * nm_dhcp4_config_new: + * @connection: the #DBusGConnection + * @object_path: the DBus object path of the device + * + * Creates a new #NMDHCP4Config. + * + * Returns: a new configuration + **/ GObject * nm_dhcp4_config_new (DBusGConnection *connection, const char *object_path) { @@ -157,6 +172,15 @@ nm_dhcp4_config_new (DBusGConnection *connection, const char *object_path) NULL); } +/** + * nm_dhcp4_config_get_options: + * @self: a #NMDHCP4Config + * + * Gets all the options contained in the configuration. + * + * Returns: the #GHashTable containing strings for keys and values. + * This is the internal copy used by the configuration, and must not be modified. + **/ GHashTable * nm_dhcp4_config_get_options (NMDHCP4Config *self) { @@ -179,6 +203,16 @@ out: return priv->options; } +/** + * nm_dhcp4_config_get_one_option: + * @self: a #NMDHCP4Config + * @option: the option to retrieve + * + * Gets one option by option name. + * + * Returns: the configuration option's value. This is the internal string used by the + * configuration, and must not be modified. + **/ const char * nm_dhcp4_config_get_one_option (NMDHCP4Config *self, const char *option) { |