[glibmm] Gio::Socket::bind() docs: Use @a instead of <tt></tt> for a parameter.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] Gio::Socket::bind() docs: Use @a instead of <tt></tt> for a parameter.
- Date: Wed, 26 Feb 2014 10:06:41 +0000 (UTC)
commit 40137fc9a71a25cfee52e2d8c8f83275a319fc3a
Author: Murray Cumming <murrayc murrayc com>
Date: Wed Feb 26 11:05:41 2014 +0100
Gio::Socket::bind() docs: Use @a instead of <tt></tt> for a parameter.
* gio/src/socket.hg: @a is the doxygen way to say that we are
referring to a parameter in the method being documented.
gio/src/socket.hg | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/gio/src/socket.hg b/gio/src/socket.hg
index a4f30ed..bcaa9d3 100644
--- a/gio/src/socket.hg
+++ b/gio/src/socket.hg
@@ -129,14 +129,14 @@ public:
* you may also want to bind a socket that will be used to initiate connections,
* though this is not normally required.
*
- * If socket is a TCP socket, then <tt>allow_reuse</tt> controls the setting of the SO_REUSEADDR
+ * If socket is a TCP socket, then @a allow_reuse controls the setting of the SO_REUSEADDR
* socket option; normally it should be <tt>true</tt> for server sockets (sockets that you
* will eventually call Socket::accept() on), and <tt>false</tt> for client sockets.
* (Failing to set this flag on a server socket may cause Socket::bind() to
* throw Gio::Error with ADDRESS_IN_USE if the server program
* is stopped and then immediately restarted.)
*
- * If socket is a UDP socket, then allow_reuse determines whether or not
+ * If socket is a UDP socket, then @a allow_reuse determines whether or not
* other UDP sockets can be bound to the same address at the same time. In particular,
* you can have several UDP sockets bound to the same address, and they will all
* receive all of the multicast and broadcast packets sent to that address.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]