Split cpu/cpu.h in 3 files: irq, types and attr.

[bertos.git] / mware / event.h

diff --git a/mware/event.h b/mware/event.h
old mode 100755 (executable)
new mode 100644 (file)
index c81b3ea..65ad31c
--- a/mware/event.h
+++ b/mware/event.h
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  * Copyright 1999, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \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);