diff options
| author | Kjell Ahlstedt <kjell.ahlstedt@bredband.net> | 2013-01-27 11:05:34 +0100 |
|---|---|---|
| committer | Kjell Ahlstedt <kjell.ahlstedt@bredband.net> | 2013-01-27 11:05:34 +0100 |
| commit | 0759fe84d17590eba58689f8d416b626b9b36b9c (patch) | |
| tree | c65c41f3ba3a081f839acbc50dbf7d121ac1d38f /gio/src/socket.hg | |
| parent | d1ccc3bae88396f03e5889286db50547a45dbfed (diff) | |
| download | glibmm-0759fe84d17590eba58689f8d416b626b9b36b9c.tar.gz | |
Documentation: Fix many warnings from Doxygen.
* gio/src/gio_docs_override.xml:
* glib/src/glib_docs_override.xml: Move "Since: n.m" from the <return> to the
<description> entries. gmmproc adds a period at the end of the @return
Doxygen command, and Doxygen warns for "@newin{n,m}.".
* glib/glibmm/interface.h:
* glib/glibmm/stringutils.h:
* glib/glibmm/vectorutils.h:
* gio/src/*.hg:
* glib/src/*.hg: (Here "*" means "many", not "all") Examples of changes:
Add missing @param. Change names of parameters, to make them equal in
function declaration and @param command. Change "@name" to "@a name".
Change "<ulink url=" to "<a href=".
Diffstat (limited to 'gio/src/socket.hg')
| -rw-r--r-- | gio/src/socket.hg | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/gio/src/socket.hg b/gio/src/socket.hg index 602d0452..7b5188dd 100644 --- a/gio/src/socket.hg +++ b/gio/src/socket.hg @@ -100,7 +100,8 @@ protected: public: _WRAP_METHOD_DOCS_ONLY(g_socket_new) - /** @throw Glib::Error + /** @param cancellable A Cancellable, or <tt>0</tt>. + * @throw Glib::Error */ static Glib::RefPtr<Socket> create(SocketFamily family, SocketType type, SocketProtocol protocol, @@ -112,7 +113,8 @@ public: _IGNORE(g_socket_connection_factory_create_connection) _WRAP_METHOD_DOCS_ONLY(g_socket_new_from_fd) - /** @throw Glib::Error + /** @param cancellable A Cancellable, or <tt>0</tt>. + * @throw Glib::Error */ static Glib::RefPtr<Socket> create_from_fd(int fd, const Glib::RefPtr<Cancellable>& cancellable = Glib::RefPtr<Cancellable>()); @@ -203,7 +205,7 @@ public: _WRAP_METHOD(void set_multicast_ttl(guint ttl), g_socket_set_multicast_ttl) _WRAP_METHOD(bool join_multicast_group(const Glib::RefPtr<InetAddress>& group, bool source_specific, const std::string& iface{?}), g_socket_join_multicast_group, errthrow) - _WRAP_METHOD(bool leave_multicast_group(const Glib::RefPtr<InetAddress>& ggroup, bool source_specific, const std::string& iface{?}), g_socket_leave_multicast_group, errthrow) + _WRAP_METHOD(bool leave_multicast_group(const Glib::RefPtr<InetAddress>& group, bool source_specific, const std::string& iface{?}), g_socket_leave_multicast_group, errthrow) _WRAP_PROPERTY("blocking", bool) |