X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=mware%2Flist.h;h=d8e2d7bcebcde5e4ca52acb0b45781fd67833fb5;hb=22dbb0cdd9a46c421a1c47bd33e1d564ce5ad44b;hp=8d89b4d61736748f77b4230c6631e1ec30550b3b;hpb=ed5f76b3d2ed4a7d68aef19981a873f12acabba0;p=bertos.git

diff --git a/mware/list.h b/mware/list.h
old mode 100755
new mode 100644
index 8d89b4d6..d8e2d7bc
--- a/mware/list.h
+++ b/mware/list.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 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2001 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \version $Id$
@@ -15,6 +40,9 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.20  2006/07/19 12:56:28  bernie
+ *#* Convert to new Doxygen style.
+ *#*
  *#* Revision 1.19  2006/03/20 17:50:29  bernie
  *#* Fix typo.
  *#*
@@ -80,7 +108,7 @@
 #include <cfg/compiler.h> /* INLINE */
 #include <cfg/debug.h> /* ASSERT() */
 
-/*!
+/**
  * This structure represents a node for bidirectional lists.
  *
  * Data is usually appended to nodes by making them the first
@@ -92,7 +120,7 @@ typedef struct _Node
 	struct _Node *pred;
 } Node;
 
-/*!
+/**
  * Head of a doubly-linked list of \c Node structs.
  *
  * Lists must be initialized with LIST_INIT() prior to use.
@@ -117,7 +145,7 @@ typedef struct _PriNode
 } PriNode;
 
 
-/*!
+/**
  * Template for a naked node in a list of \a T structures.
  *
  * To be used as data member in other structures:
@@ -150,11 +178,11 @@ typedef struct _PriNode
 #define DECLARE_NODE_ANON(T) \
 	T *succ; T *pred;
 
-/*! Declare a typesafe node for structures of type \a T. */
+/** Declare a typesafe node for structures of type \a T. */
 #define DECLARE_NODE_TYPE(T) \
 	typedef struct T##Node { T *succ; T *pred; } T##Node
 
-/*! Template for a list of \a T structures. */
+/** Template for a list of \a T structures. */
 #define DECLARE_LIST_TYPE(T) \
 	DECLARE_NODE_TYPE(T); \
 	typedef struct T##List { \
@@ -165,14 +193,14 @@ typedef struct _PriNode
 #define NODE_TYPE(T) T##Node
 #define LIST_TYPE(T) T##List
 
-/*!
+/**
  * Get a pointer to the first node in a list.
  *
  * If \a l is empty, result points to l->tail.
  */
 #define LIST_HEAD(l) ((l)->head.succ)
 
-/*!
+/**
  * Get a pointer to the last node in a list.
  *
  * If \a l is empty, result points to l->head.
@@ -186,7 +214,7 @@ typedef struct _PriNode
 	#define TYPEOF_OR_VOIDPTR(type) void *
 #endif
 
-/*!
+/**
  * Iterate over all nodes in a list.
  *
  * This macro generates a "for" statement using the following parameters:
@@ -200,7 +228,7 @@ typedef struct _PriNode
 		(n) = (TYPEOF_OR_VOIDPTR(n))(((Node *)(n))->succ) \
 	)
 
-/*!
+/**
  * Iterate backwards over all nodes in a list.
  *
  * This macro generates a "for" statement using the following parameters:
@@ -214,7 +242,7 @@ typedef struct _PriNode
 		(n) = (TYPEOF_OR_VOIDPTR(n))(((Node *)(n))->pred) \
 	)
 
-/*! Initialize a list. */
+/** Initialize a list. */
 #define LIST_INIT(l) \
 	do { \
 		(l)->head.succ = (TYPEOF_OR_VOIDPTR((l)->head.succ)) &(l)->tail; \
@@ -224,7 +252,7 @@ typedef struct _PriNode
 	} while (0)
 
 #ifdef _DEBUG
-	/*! Make sure that a list is valid (it was initialized and is not corrupted). */
+	/** Make sure that a list is valid (it was initialized and is not corrupted). */
 	#define LIST_ASSERT_VALID(l) \
 		do { \
 			Node *n, *pred; \
@@ -247,7 +275,7 @@ typedef struct _PriNode
 	#define INVALIDATE_NODE(n) do {} while (0)
 #endif
 
-/*! Add node to list head. */
+/** Add node to list head. */
 #define ADDHEAD(l,n) \
 	do { \
 		ASSERT(l); \
@@ -258,7 +286,7 @@ typedef struct _PriNode
 		(n)->pred->succ = (n); \
 	} while (0)
 
-/*! Add node to list tail. */
+/** Add node to list tail. */
 #define ADDTAIL(l,n) \
 	do { \
 		ASSERT(l); \
@@ -269,7 +297,7 @@ typedef struct _PriNode
 		(l)->tail.pred = (n); \
 	} while (0)
 
-/*!
+/**
  * Insert node \a n before node \a ln.
  *
  * \note You can't pass in a list header as \a ln, but
@@ -283,7 +311,7 @@ typedef struct _PriNode
 		(ln)->pred = (n); \
 	} while (0)
 
-/*!
+/**
  * Remove \a n from whatever list it is in.
  *
  * \note Removing a node that has not previously been
@@ -296,7 +324,7 @@ typedef struct _PriNode
 		INVALIDATE_NODE(n); \
 	} while (0)
 
-/*! Tell whether a list is empty. */
+/** Tell whether a list is empty. */
 #define LIST_EMPTY(l)  ( (void *)((l)->head.succ) == (void *)(&(l)->tail) )
 
 /**
@@ -316,7 +344,7 @@ typedef struct _PriNode
 	} while (0)
 
 
-/*!
+/**
  * Unlink a node from the head of the list \a l.
  *
  * \return Pointer to node, or NULL if the list was empty.
@@ -336,7 +364,7 @@ INLINE Node *list_remHead(List *l)
 	return n;
 }
 
-/*!
+/**
  * Unlink a node from the tail of the list \a l.
  *
  * \return Pointer to node, or NULL if the list was empty.