[glibmm] Fix documentation of enum Glib::IOCondition
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] Fix documentation of enum Glib::IOCondition
- Date: Mon, 12 Jun 2017 13:51:32 +0000 (UTC)
commit 6c4124a36e7863b86d42db7c5034af9c1fb77483
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date: Mon Jun 12 15:44:51 2017 +0200
Fix documentation of enum Glib::IOCondition
* glib/src/iochannel.hg: The code snippet needs a fix when IOCondition is
a scoped enum (enum class). Doxygen needs "@enum IOCondition" before the
extra documentation.
glib/src/iochannel.hg | 7 ++++---
1 files changed, 4 insertions(+), 3 deletions(-)
---
diff --git a/glib/src/iochannel.hg b/glib/src/iochannel.hg
index 63b0c54..7a3ade1 100644
--- a/glib/src/iochannel.hg
+++ b/glib/src/iochannel.hg
@@ -18,7 +18,7 @@
_DEFS(glibmm,glib)
#include <glibmmconfig.h>
-#include <glib.h> //For the GIOChannel enum values.
+#include <glib.h> //For the GIOCondition enum values.
#include <glibmm/error.h>
#include <glibmm/refptr.h>
#include <glibmm/ustring.h>
@@ -40,13 +40,14 @@ _WRAP_ENUM(IOStatus, GIOStatus, NO_GTYPE, s#^EOF$#ENDOFFILE#)
_WRAP_ENUM(IOFlags, GIOFlags, NO_GTYPE)
-/** A bitwise combination representing an I/O condition to watch for on an
+/** @enum IOCondition
+ * A bitwise combination representing an I/O condition to watch for on an
* event source.
* The flags correspond to those used by the <tt>%poll()</tt> system call
* on UNIX (see <tt>man 2 poll</tt>). To test for individual flags, do
* something like this:
* @code
- * if((condition & Glib::IO_OUT) != 0)
+ * if ((condition & Glib::IOCondition::OUT) == Glib::IOCondition::OUT)
* do_some_output();
* @endcode
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]