diff --git a/libnm-util/nm-connection.c b/libnm-util/nm-connection.c index ccf3fb82ba..a97167664c 100644 --- a/libnm-util/nm-connection.c +++ b/libnm-util/nm-connection.c @@ -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: * diff --git a/libnm-util/nm-connection.h b/libnm-util/nm-connection.h index 77ad6c8fa6..4e92c17807 100644 --- a/libnm-util/nm-connection.h +++ b/libnm-util/nm-connection.h @@ -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);