diff --git a/docs/libnm-glib/Makefile.am b/docs/libnm-glib/Makefile.am index 6fa728255e..7dfea79afe 100644 --- a/docs/libnm-glib/Makefile.am +++ b/docs/libnm-glib/Makefile.am @@ -5,7 +5,7 @@ AUTOMAKE_OPTIONS = 1.6 DOC_MODULE=libnm-glib # The top-level SGML file. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml # The directory containing the source code. Relative to $(srcdir). # gtk-doc will search all .c & .h files beneath here for inline comments @@ -58,7 +58,7 @@ IGNORE_HFILES= \ nm-vpn-plugin-glue.h # Images to copy into HTML directory. -HTML_IMAGES = +HTML_IMAGES = libnm-glib.png # Extra XML files that are included by $(DOC_MAIN_SGML_FILE). content_files = diff --git a/docs/libnm-glib/libnm-glib-docs.sgml b/docs/libnm-glib/libnm-glib-docs.sgml deleted file mode 100644 index ab48935002..0000000000 --- a/docs/libnm-glib/libnm-glib-docs.sgml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - libnm-glib Reference Manual - - for libnm-glib 0.9 - The latest version of this documentation can be found on-line at - http://projects.gnome.org/NetworkManager/developers/libnm-glib/09/. - - - - - libnm-glib API Reference - - - - - - - - - - - - - - - - - - - - - - - - - - Object Hierarchy - - - - API Index - - - - - - diff --git a/docs/libnm-glib/libnm-glib-docs.xml b/docs/libnm-glib/libnm-glib-docs.xml new file mode 100644 index 0000000000..533010e157 --- /dev/null +++ b/docs/libnm-glib/libnm-glib-docs.xml @@ -0,0 +1,118 @@ + + + + + libnm-glib Reference Manual + + for libnm-glib 0.9 + The latest version of this documentation can be found on-line at + http://projects.gnome.org/NetworkManager/developers/libnm-glib/09/. + + + + Dan + Williams + +
+ dcbw@redhat.com +
+ + + + + + 2011 + The NetworkManager Authors + + + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free + Documentation License, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the GNU Free + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: + +
+ The Free Software Foundation, Inc., + 59 Temple Place - Suite 330, + Boston, MA 02111-1307, + USA +
+ + + + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any GNOME documentation, and those trademarks + are made aware to the members of the GNOME Documentation + Project, the names have been printed in caps or initial caps. + + + + + + Object Overview + + libnm-glib maps closely to the actual D-Bus API that NetworkManager + provides, simply wrapping the remote D-Bus objects as native GObjects, + mapping D-Bus signals and properties to GObject signals and properties, + and providing helpful accessor and utility functions. As such, objects + in the libnm-glib API have the same properties, behavior, signals, and + semantics as the NM D-Bus API. + + + The following is a rough overview of the libnm-glib object structure and + how to use the various parts of it: + + + + + + + + + + libnm-glib API Reference + + + + + + + + + + + + + + + + + + + + + + + + + + Object Hierarchy + + + + API Index + + + + + + diff --git a/docs/libnm-glib/libnm-glib.png b/docs/libnm-glib/libnm-glib.png new file mode 100644 index 0000000000..dc00072842 Binary files /dev/null and b/docs/libnm-glib/libnm-glib.png differ diff --git a/docs/libnm-glib/libnm-glib.svg b/docs/libnm-glib/libnm-glib.svg new file mode 100644 index 0000000000..a0d240fae6 --- /dev/null +++ b/docs/libnm-glib/libnm-glib.svg @@ -0,0 +1,893 @@ + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + Propr + NMClient + Base object; provides access tonetwork device objects, activenetwork connection objects andgeneral network state information + + + + NMRemoteSettings + Retrieves, adds, and notifes of changesto network configuration objects(called NMRemoteConnections) + + NMRemoteConnection + The basic unit of networkconfiguration information,contains all settings required toconnect to a specific network. + + NMRemoteConnection + + NMRemoteConnection + + NMRemoteConnection + + + + + + + + + NMDevice + Represents a known networkinterface that may be used toconnect to a network + + nm_client_get_devices() + + + NMActiveConnection + Represents an active connectionto a specific network, usingsettings from anNMRemoteConnection,andprovided by on or more NMDeviceobjects. + + nm_active_connection_get_devices() + + + + NMDeviceWifi + + + + NMDeviceModem + + + + NMDeviceWimax + + + + NMDeviceBluetooth + + + + + + + + + NMDeviceEthernet + + + + + + nm_client_get_active_connections() + (Device subclasses) + Gets all known interfaces + Gets interfaces used by this active connection + Gets all active network connections + + Retrieve the NMRemoteConnection that providesconfiguration settings for the NMActiveConnectionby getting its object path withnm_active_connection_get_connection() and thenpassing the returned path tonm_remote_settings_get_connection_by_path() + NetworkConfiguration + Network Control + Connect to a network by callingnm_client_activate_connection() andpassing the NMDevice to use, along withthe NMRemoteConnection that containsthe settings that describe how to connectto that network + + + + NMActiveConnection + + + + NMActiveConnection + + + + + + + + +