diff -r e4a3586c6ca6 -r 3fe1d226b332 src/helpers.hpp --- a/src/helpers.hpp Fri Feb 23 21:03:57 2007 +0000 +++ b/src/helpers.hpp Fri Feb 23 21:29:50 2007 +0000 @@ -80,12 +80,23 @@ /** Informative template class exposing basic enumeration properties used by several * other templates below. Here we have only forward declaration. For each enum type - * we will create specialization derived from MakeEnumPropsT<>. */ + * we will create specialization derived from MakeEnumPropsT<>. + * i.e.: + * template <> struct EnumPropsT : MakeEnumPropsT {}; + * followed by: + * typedef TinyEnumT TrackByte; + */ template struct EnumPropsT; /** Helper template class that makes basic properties of given enumeration type visible * from outsize. It is used as base class of several EnumPropsT specializations each - * dedicated to one of commonly used enumeration types. */ + * dedicated to one of commonly used enumeration types. + * @param Tenum_t enumeration type that you want to describe + * @param Tstorage_t what storage type would be sufficient (i.e. byte) + * @param Tbegin first valid value from the contiguous range (i.e. TRACK_BEGIN) + * @param Tend one past the last valid value from the contiguous range (i.e. TRACK_END) + * @param Tinvalid value used as invalid value marker (i.e. INVALID_TRACK) + */ template struct MakeEnumPropsT { typedef Tenum_t type; ///< enum type (i.e. Trackdir)