summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMurray Cumming <murrayc@murrayc.com>2011-04-06 15:01:34 +0200
committerMurray Cumming <murrayc@murrayc.com>2011-04-06 15:01:34 +0200
commit02d1204e3b4935bbc0a30ce809f2b57af5ab2881 (patch)
tree72b9b49602ce2f5b749e84b4477997744a0cef17
parentcfe1e3456c014539cad3a8c0477da6056c029d41 (diff)
downloadglibmm-02d1204e3b4935bbc0a30ce809f2b57af5ab2881.tar.gz
Minor documentation improvements.
* gio/src/proxy.hg: * gio/src/proxyaddress.hg: * gio/src/proxyresolver.hg: * gio/src/socketcontrolmessage.hg: * gio/src/unixcredentialsmessage.hg: * gio/src/unixfdlist.hg: * gio/src/unixfdmessage.hg: Added these to NetworkIO doxygen group. * glib/glibmm.h: Mention Gio::Settings.
-rw-r--r--ChangeLog13
-rw-r--r--gio/src/proxy.hg8
-rw-r--r--gio/src/proxyaddress.hg6
-rw-r--r--gio/src/proxyresolver.hg24
-rw-r--r--gio/src/socketcontrolmessage.hg1
-rw-r--r--gio/src/unixcredentialsmessage.hg1
-rw-r--r--gio/src/unixfdlist.hg1
-rw-r--r--gio/src/unixfdmessage.hg3
-rw-r--r--glib/glibmm.h1
9 files changed, 40 insertions, 18 deletions
diff --git a/ChangeLog b/ChangeLog
index 89c5aac2..c003cc3d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,18 @@
2011-04-06 Murray Cumming <murrayc@murrayc.com>
+ Minor documentation improvements.
+
+ * gio/src/proxy.hg:
+ * gio/src/proxyaddress.hg:
+ * gio/src/proxyresolver.hg:
+ * gio/src/socketcontrolmessage.hg:
+ * gio/src/unixcredentialsmessage.hg:
+ * gio/src/unixfdlist.hg:
+ * gio/src/unixfdmessage.hg: Added these to NetworkIO doxygen group.
+ * glib/glibmm.h: Mention Gio::Settings.
+
+2011-04-06 Murray Cumming <murrayc@murrayc.com>
+
DBus docs: Add a descripton for the doxygen group.
* gio/src/dbusconnection.hg: Expand the defgroup doxygen comment block.
diff --git a/gio/src/proxy.hg b/gio/src/proxy.hg
index d31d9556..7b0eb7bf 100644
--- a/gio/src/proxy.hg
+++ b/gio/src/proxy.hg
@@ -43,8 +43,9 @@ namespace Gio
* SOCKS5 proxy implementation can be retrieved with the name 'socks5' using
* the C API's function g_io_extension_point_get_extension_by_name().
*
+ * @ingroup NetworkIO
* @newin{2,28}
- */
+ */
class Proxy : public Glib::Interface
{
_CLASS_INTERFACE(Proxy, GProxy, G_PROXY, GProxyInterface)
@@ -59,18 +60,17 @@ public:
/** An Asynchronous version of connect().
*/
void connect_async(const Glib::RefPtr<IOStream>& connection, const Glib::RefPtr<const ProxyAddress>& proxy_address, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable);
-
+
/** An Asynchronous version of connect().
*/
void connect_async(const Glib::RefPtr<IOStream>& connection, const Glib::RefPtr<const ProxyAddress>& proxy_address, const SlotAsyncReady& slot);
_IGNORE(g_proxy_connect_async)
_WRAP_METHOD(Glib::RefPtr<IOStream> connect_finish(const Glib::RefPtr<AsyncResult>& result), g_proxy_connect_finish, errthrow)
-
+
_WRAP_METHOD(bool supports_hostname() const, g_proxy_supports_hostname)
};
} // namespace Gio
-
diff --git a/gio/src/proxyaddress.hg b/gio/src/proxyaddress.hg
index 4740454f..05e6d52d 100644
--- a/gio/src/proxyaddress.hg
+++ b/gio/src/proxyaddress.hg
@@ -28,6 +28,7 @@ namespace Gio
/** ProxyAddress - An internet address with proxy information.
* Support for proxied InetSocketAddress.
*
+ * @ingroup NetworkIO
* @newin{2,28}
*/
class ProxyAddress
@@ -59,10 +60,13 @@ public:
_WRAP_METHOD(Glib::ustring get_username() const, g_proxy_address_get_username)
_WRAP_METHOD(Glib::ustring get_password() const, g_proxy_address_get_password)
-
+
_WRAP_PROPERTY("protocol", Glib::ustring)
_WRAP_PROPERTY("destination_hostname", Glib::ustring)
+
+//TODO: This should really be a guint16:
_WRAP_PROPERTY("destination_port", Glib::ustring)
+
_WRAP_PROPERTY("username", Glib::ustring)
_WRAP_PROPERTY("password", Glib::ustring)
};
diff --git a/gio/src/proxyresolver.hg b/gio/src/proxyresolver.hg
index df90c019..61189afe 100644
--- a/gio/src/proxyresolver.hg
+++ b/gio/src/proxyresolver.hg
@@ -39,8 +39,9 @@ namespace Gio
* resolution. ProxyResolver is used within ClientSocket through the method
* Gio::SocketConnectable::proxy_enumerate().
*
+ * @ingroup NetworkIO
* @newin{2,28}
- */
+ */
class ProxyResolver : public Glib::Interface
{
_CLASS_INTERFACE(ProxyResolver, GProxyResolver, G_PROXY_RESOLVER, GProxyResolverInterface)
@@ -48,35 +49,35 @@ class ProxyResolver : public Glib::Interface
public:
_WRAP_METHOD(static Glib::RefPtr<ProxyResolver> get_default(), g_proxy_resolver_get_default)
-
+
_WRAP_METHOD(bool is_supported() const, g_proxy_resolver_is_supported)
//TODO: Use std::string instead of ustring (StringArrayHandle uses ustring)?:
#m4 _CONVERSION(`gchar**',`std::vector<Glib::ustring>',`Glib::ArrayHandler<Glib::ustring>::array_to_vector($3, Glib::OWNERSHIP_DEEP)')
_WRAP_METHOD(std::vector<Glib::ustring> lookup(const Glib::ustring& uri,
const Glib::RefPtr<Cancellable>& cancellable), g_proxy_resolver_lookup, errthrow)
-
- /** Looks into the system proxy configuration to determine what proxy, if any, to use to connect to uri.
+
+ /** Looks into the system proxy configuration to determine what proxy, if any, to use to connect to uri.
* The returned proxy URIs are of the form <protocol>://[user[:password]@]host:port or direct://, where <protocol> could be http, rtsp, socks or other proxying protocol.
*
- * If you don't know what network protocol is being used on the socket, you should use none as the URI protocol.
+ * If you don't know what network protocol is being used on the socket, you should use none as the URI protocol.
* In this case, the resolver might still return a generic proxy type (such as SOCKS), but would not return protocol-specific proxy types (such as http).
*
* direct:// is used when no proxy is needed. Direct connection should not be attempted unless it is part of the returned array of proxies.
*
- * @param uri a URI representing the destination to connect to.
+ * @param uri a URI representing the destination to connect to.
*/
std::vector<Glib::ustring> lookup(const Glib::ustring& uri);
-
- /** Asynchronous lookup of proxy. See lookup() for more details.
- * @param uri a URI representing the destination to connect to.
+
+ /** Asynchronous lookup of proxy. See lookup() for more details.
+ * @param uri a URI representing the destination to connect to.
* @param slot A callback slot to call after the resolution completes.
* @param cancellable A Cancellable object which can be used to cancel the operation.
*/
void lookup_async(const Glib::ustring& uri, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable);
-
+
/** Asynchronous lookup of proxy. See lookup() for more details.
- * @param uri a URI representing the destination to connect to.
+ * @param uri a URI representing the destination to connect to.
* @param slot A callback slot to call after the resolution completes.
*/
void lookup_async(const Glib::ustring& uri, const SlotAsyncReady& slot);
@@ -89,4 +90,3 @@ public:
} // namespace Gio
-
diff --git a/gio/src/socketcontrolmessage.hg b/gio/src/socketcontrolmessage.hg
index ddb5e691..834393b3 100644
--- a/gio/src/socketcontrolmessage.hg
+++ b/gio/src/socketcontrolmessage.hg
@@ -45,6 +45,7 @@ namespace Gio
* registered with the GType typesystem before calling
* Gio::Socket::receive() to read such a message.
*
+ * @ingroup NetworkIO
* @newin{2,28}
*/
class SocketControlMessage : public Glib::Object
diff --git a/gio/src/unixcredentialsmessage.hg b/gio/src/unixcredentialsmessage.hg
index ff13e0d2..1ad95233 100644
--- a/gio/src/unixcredentialsmessage.hg
+++ b/gio/src/unixcredentialsmessage.hg
@@ -37,6 +37,7 @@ class Credentials;
* Gio::UnixConnection::receive_credentials(). To receive credentials of a
* foreign process connected to a socket, use Gio::Socket::get_credentials().
*
+ * @ingroup NetworkIO
* @newin{2,28}
*/
class UnixCredentialsMessage : public SocketControlMessage
diff --git a/gio/src/unixfdlist.hg b/gio/src/unixfdlist.hg
index 7cd152ca..ae215f4b 100644
--- a/gio/src/unixfdlist.hg
+++ b/gio/src/unixfdlist.hg
@@ -34,6 +34,7 @@ namespace Gio
* G_SOCKET_ADDRESS_UNIX family by using Gio::Socket::send() and received
* using Gio::Socket::receive().
*
+ * @ingroup NetworkIO
* @newin{2,28}
*/
class UnixFDList : public Glib::Object
diff --git a/gio/src/unixfdmessage.hg b/gio/src/unixfdmessage.hg
index 9f22fb04..b07a31bb 100644
--- a/gio/src/unixfdmessage.hg
+++ b/gio/src/unixfdmessage.hg
@@ -35,8 +35,9 @@ class UnixFDList;
*
* For an easier way to send and receive file descriptors over stream-oriented
* UNIX sockets, see Gio::UnixConnection::send_fd() and
- * Gio::UnixConnection::receive_fd().
+ * Gio::UnixConnection::receive_fd().
*
+ * @ingroup NetworkIO
* @newin{2,28}
*/
class UnixFDMessage : public SocketControlMessage
diff --git a/glib/glibmm.h b/glib/glibmm.h
index e404488f..4626fa2e 100644
--- a/glib/glibmm.h
+++ b/glib/glibmm.h
@@ -51,6 +51,7 @@
* - Asynchronous IO. See Gio::File and the @ref Streams.
* - @ref NetworkIO
* - @ref DBus
+ * - Gio::Settings for application settings.
*
* @section basics Basic Usage
*