[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [libnm-qt] /: Update documentation.
From:       Lamarque V. Souza <lamarque () kde ! org>
Date:       2013-08-31 19:10:39
Message-ID: E1VFqZD-0002sN-2P () scm ! kde ! org
[Download RAW message or body]

Git commit 58a90802927aa5525819a0f568d31591dc3d4d9c by Lamarque V. Souza.
Committed on 31/08/2013 at 17:13.
Pushed by lvsouza into branch 'master'.

Update documentation.

M  +3    -0    examples/main.cpp
M  +5    -2    ipconfig.h

http://commits.kde.org/libnm-qt/58a90802927aa5525819a0f568d31591dc3d4d9c

diff --git a/examples/main.cpp b/examples/main.cpp
index 5a13abc..d239406 100644
--- a/examples/main.cpp
+++ b/examples/main.cpp
@@ -49,6 +49,8 @@ int main()
 
     NetworkManager::Device::List list = NetworkManager::networkInterfaces();
 
+    // List device configuration, not including vpn connections, which do not
+    // have a real device tied to them.
     foreach (NetworkManager::Device::Ptr dev, list) {
         qout << "\n=====\n";
         qout << dev->uni() << "\n";
@@ -67,6 +69,7 @@ int main()
                 qout << "gateway: " << address.gateway().toString() << "\n";
                 qout << "ip address (raw): " << dev->ipV4Address().toString() << "\n";
 
+                // Static routes.
                 if (ipConfig.routes().isEmpty()) {
                     qout << "routers: <not set>\n";
                 } else {
diff --git a/ipconfig.h b/ipconfig.h
index 3d34ac6..cea3b30 100644
--- a/ipconfig.h
+++ b/ipconfig.h
@@ -69,7 +69,9 @@ public:
     void setIPv6Path(const QString &path);
 
     /**
-     * Returns a list of IP addresses related to this configuration.
+     * Returns a list of IP addresses and gateway related to this configuration.
+     * Use IpAddress::ip() to access the IP address and IpAddress::gateway()
+     * to access the gateway address.
      */
     NetworkManager::IpAddresses addresses() const;
 
@@ -84,7 +86,8 @@ public:
     QStringList domains() const;
 
     /**
-     * Returns a list of routes related to this configuration.
+     * Returns a list of static routes (not the default gateway) related to this configuration.
+     * Use @ref addresses() to retrieve the default gateway.
      */
     IpRoutes routes() const;
 

[prev in list] [next in list] [prev in thread] [next in thread]