diff --git a/Scheduler/Scheduler.hh b/Scheduler/Scheduler.hh index 5f0f635c5ee8d319264666a0e4f43d3b91d5ff05..34e625cf2211b6a53978f6f5ddf080a66a6f4f2e 100644 --- a/Scheduler/Scheduler.hh +++ b/Scheduler/Scheduler.hh @@ -167,11 +167,23 @@ namespace senf { /////////////////////////////////////////////////////////////////////////// // Types - /** \brief Types of file descriptor events */ - enum EventId { EV_NONE=0, - EV_READ=1, EV_PRIO=2, EV_WRITE=4, - EV_ALL=7, - EV_HUP=8, EV_ERR=16 }; + /** \brief Types of file descriptor events + + These events are grouped into to classes: + \li Ordinary file descriptor events for which handlers may be registered. These are + EV_READ, EV_PRIO and EV_WRITE. EV_ALL is a combination of these three. + \li Error flags. These additional flags may be passed to a handler to pass an error + condition to the handler. + */ + enum EventId { + EV_NONE = 0 /**< No event */ + , EV_READ = 1 /**< File descriptor is readable */ + , EV_PRIO = 2 /**< File descriptor has OOB data */ + , EV_WRITE = 4 /**< File descriptor is writable */ + , EV_ALL = 7 /**< Used to register all events at once (read/prio/write) */ + , EV_HUP = 8 /**< Hangup condition on file handle */ + , EV_ERR = 16 /**< Error condition on file handle */ + }; /** \brief Template typedef for Callback type diff --git a/doclib/Doxyfile.global b/doclib/Doxyfile.global index 5ffddee58f59cfd8a2a8ffdbabcf362d989fe4b0..6e4537585de243197610850b3f07a23a191c266f 100644 --- a/doclib/Doxyfile.global +++ b/doclib/Doxyfile.global @@ -60,7 +60,10 @@ PREDEFINED = \ "SENF_PARSER_LIST_N(name,elt_type,size_type)=senf::Parse_ListN<elt_type,size_type>::parser name() const" \ "SENF_PARSER_VARIANT(name,chooser,types)=senf::Parse_Variant_Direct<chooser ## _t,?,types>::parser name() const" \ "SENF_PARSER_PRIVATE_VARIANT(name,chooser,types)=private: senf::Parse_Variant_Direct<chooser ## _t,?,types>::parser name() const; public:" \ - "SENF_PARSER_VEC_N(name,elt_type,size_type)=senf::Parse_VectorN<elt_type,size_type> name() const" + "SENF_PARSER_VEC_N(name,elt_type,size_type)=senf::Parse_VectorN<elt_type,size_type> name() const" \ + "SENF_LOG_CLASS_AREA()=" \ + "SENF_LOG_DEFAULT_AREA(area)=" \ + "SENF_LOG_DEFAULT_STREAM(stream)=" EXPAND_AS_DEFINED = prefix_ SENF_LOG_DEF_STREAM SENF_LOG_DEF_AREA SENF_LOG_DEF_AREA_I HTML_HEADER = "$(TOPDIR)/doclib/doxy-header.html"