X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=mware%2Fevent.h;h=65ad31c2d3a351c82ba69623b1abd2d84cb038b0;hb=9fc47ff8814e045ac498acb1bc92946950a6a5f9;hp=c81b3eabb095e92f4d305f94528306c7635fe841;hpb=18ebc3f9f66aceeaa4c9ceda7d9d080430d41868;p=bertos.git diff --git a/mware/event.h b/mware/event.h old mode 100755 new mode 100644 index c81b3eab..65ad31c2 --- a/mware/event.h +++ b/mware/event.h @@ -1,9 +1,34 @@ -/*! +/** * \file * * * \brief Events handling @@ -18,6 +43,9 @@ /*#* *#* $Log$ + *#* Revision 1.8 2006/07/19 12:56:27 bernie + *#* Convert to new Doxygen style. + *#* *#* Revision 1.7 2006/03/20 17:52:22 bernie *#* Add missing forward declaration. *#* @@ -91,7 +119,7 @@ #endif -//! User defined callback type +/// User defined callback type typedef void (*Hook)(void *); typedef struct Event @@ -118,11 +146,11 @@ void event_hook_ignore(Event *event); void event_hook_signal(Event *event); void event_hook_softint(Event *event); -/*! Initialize the event \a e as a no-op */ +/** Initialize the event \a e as a no-op */ #define event_initNone(e) \ ((e)->action = event_hook_ignore) -/*! Same as event_initNone(), but returns the initialized event */ +/** Same as event_initNone(), but returns the initialized event */ INLINE Event event_createNone(void); INLINE Event event_createNone(void) { @@ -131,11 +159,11 @@ INLINE Event event_createNone(void) return e; } -/*! Initialize the event \a e with a software interrupt (call function \a f, with parameter \a u) */ +/** Initialize the event \a e with a software interrupt (call function \a f, with parameter \a u) */ #define event_initSoftInt(e,f,u) \ ((e)->action = event_hook_softint,(e)->Ev.Int.func = (f), (e)->Ev.Int.user_data = (u)) -/*! Same as event_initSoftInt(), but returns the initialized event */ +/** Same as event_initSoftInt(), but returns the initialized event */ INLINE Event event_createSoftInt(Hook func, void *user_data) { Event e; @@ -148,11 +176,11 @@ INLINE Event event_createSoftInt(Hook func, void *user_data) #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS -/*! Initialize the event \a e with a signal (send signal \a s to process \a p) */ +/** Initialize the event \a e with a signal (send signal \a s to process \a p) */ #define event_initSignal(e,p,s) \ ((e)->action = event_hook_signal,(e)->Ev.Sig.sig_proc = (p), (e)->Ev.Sig.sig_bit = (s)) -/*! Same as event_initSignal(), but returns the initialized event */ +/** Same as event_initSignal(), but returns the initialized event */ INLINE Event event_createSignal(struct Process *proc, sigbit_t bit) { Event e; @@ -164,7 +192,7 @@ INLINE Event event_createSignal(struct Process *proc, sigbit_t bit) #endif -/*! Trigger an event */ +/** Trigger an event */ INLINE void event_do(struct Event *e) { e->action(e);