BGE: Add level mode to property actuator
[blender.git] / source / blender / makesdna / DNA_listBase.h
index 5479ba25f70c8ca621c4e5747a11269a8ed6c1b6..f6035cd665362a441fecf01cadb032bb89da4b4f 100644 (file)
@@ -1,8 +1,4 @@
-/**
- * blenlib/BLI_listBase.h    mar 2001 Nzc
- *
- * $Id$ 
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
@@ -17,7 +13,7 @@
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
  *
  * ***** END GPL LICENSE BLOCK *****
  *
- * These structs are the foundation for all linked lists in the
- * library system.
  *
  */
 
-#ifndef DNA_LISTBASE_H
-#define DNA_LISTBASE_H
+/** \file DNA_listBase.h
+ *  \ingroup DNA
+ *  \brief These structs are the foundation for all linked lists in the
+ *         library system.
+ *
+ * Doubly-linked lists start from a ListBase and contain elements beginning
+ * with Link.
+ */
+
+#ifndef __DNA_LISTBASE_H__
+#define __DNA_LISTBASE_H__
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-/* generic - all structs which are used in linked-lists used this */
-typedef struct Link
-{
-       struct Link *next,*prev;
+/* generic - all structs which are put into linked lists begin with this */
+typedef struct Link {
+       struct Link *next, *prev;
 } Link;
 
 
-/* use this when it is not worth defining a custom one... */
-typedef struct LinkData
-{
+/* simple subclass of Link--use this when it is not worth defining a custom one... */
+typedef struct LinkData {
        struct LinkData *next, *prev;
        void *data;
 } LinkData;
 
 /* never change the size of this! genfile.c detects pointerlen with it */
-typedef struct ListBase 
-{
+typedef struct ListBase  {
        void *first, *last;
 } ListBase;