diff options
| author | Kjell Ahlstedt <kjellahlstedt@gmail.com> | 2017-06-12 15:44:51 +0200 |
|---|---|---|
| committer | Kjell Ahlstedt <kjellahlstedt@gmail.com> | 2017-06-12 15:44:51 +0200 |
| commit | 6c4124a36e7863b86d42db7c5034af9c1fb77483 (patch) | |
| tree | 5f551fe6edf80c13a92d10f5d54542955891f0ce | |
| parent | c0ac0dc37e3e653d4dd5d3484f0b734a7e55d525 (diff) | |
| download | glibmm-6c4124a36e7863b86d42db7c5034af9c1fb77483.tar.gz | |
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.
| -rw-r--r-- | 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 63b0c546..7a3ade14 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 */ |