Documentation updates

git-svn-id: http://svn-archive.gnome.org/svn/NetworkManager/trunk@4330 4912f4e0-d625-0410-9fb7-b9a5a253dbdc
This commit is contained in:
Dan Williams 2008-11-24 02:45:35 +00:00
parent ef20c1bbdc
commit d0dd5171ba
2 changed files with 26 additions and 5 deletions

View file

@ -45,6 +45,32 @@
#include "nm-setting-gsm.h"
#include "nm-setting-cdma.h"
/**
* SECTION:nm-connection
* @short_description: Describes a connection to specific network or provider
* @include: nm-connection.h
*
* An #NMConnection describes all the settings and configuration values that
* are necessary to configure network devices for operation on a specific
* network. Connections are the fundamental operating object for
* NetworkManager; no device is connected without a #NMConnection, or
* disconnected without having been connected with a #NMConnection.
*
* Each #NMConnection contains a list of #NMSetting objects usually referenced
* by name (using nm_connection_get_setting_by_name()) or by type (with
* nm_connection_get_setting()). The settings describe the actual parameters
* with which the network devices are configured, including device-specific
* parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters
* (addresses, routes, addressing methods, etc).
*
* Most connections also have a %NMConnectionScope; a connection will be
* provided over D-Bus either by the user settings service
* (org.freedesktop.NetworkManagerUserSettings) running in an active user
* session, or by the system-wide system settings service
* (org.freedesktop.NetworkManagerSystemSettings) which provides connections
* for all users.
*/
/**
* nm_connection_error_quark:
*

View file

@ -137,11 +137,6 @@ void nm_connection_dump (NMConnection *connection);
NMSetting *nm_connection_create_setting (const char *name);
void nm_setting_register (const char *name,
GType type);
void nm_setting_unregister (const char *name);
GType nm_connection_lookup_setting_type (const char *name);
GType nm_connection_lookup_setting_type_by_quark (GQuark error_quark);