code cleanup: headers - doxy comments.
authorCampbell Barton <ideasman42@gmail.com>
Thu, 12 Sep 2013 03:02:50 +0000 (03:02 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Thu, 12 Sep 2013 03:02:50 +0000 (03:02 +0000)
42 files changed:
source/blender/blenkernel/BKE_DerivedMesh.h
source/blender/blenkernel/BKE_addon.h
source/blender/blenkernel/BKE_ccg.h
source/blender/blenkernel/BKE_editmesh.h
source/blender/blenkernel/BKE_mask.h
source/blender/blenkernel/BKE_navmesh_conversion.h
source/blender/blenkernel/BKE_ocean.h
source/blender/blenkernel/intern/addon.c
source/blender/blenkernel/intern/dynamicpaint.c
source/blender/blenkernel/intern/ocean.c
source/blender/blenkernel/intern/pbvh_bmesh.c
source/blender/blenkernel/intern/pbvh_intern.h
source/blender/blenlib/BLI_array.h
source/blender/blenlib/BLI_bitmap.h
source/blender/blenlib/BLI_buffer.h
source/blender/blenlib/BLI_callbacks.h
source/blender/blenlib/BLI_math_interp.h
source/blender/blenlib/intern/BLI_array.c
source/blender/blenlib/intern/buffer.c
source/blender/blenlib/intern/callbacks.c
source/blender/blenlib/intern/convexhull2d.c
source/blender/blenlib/intern/math_interp.c
source/blender/blenlib/intern/smallhash.c
source/blender/bmesh/intern/bmesh_log.c
source/blender/bmesh/intern/bmesh_log.h
source/blender/datatoc/datatoc.c
source/blender/editors/mesh/mesh_navmesh.c
source/blender/editors/physics/dynamicpaint_ops.c
source/blender/freestyle/intern/stroke/TextStrokeRenderer.cpp
source/blender/freestyle/intern/stroke/TextStrokeRenderer.h
source/blender/imbuf/IMB_colormanagement.h
source/blender/imbuf/intern/IMB_colormanagement_intern.h
source/blender/imbuf/intern/IMB_indexer.h
source/blender/imbuf/intern/colormanagement.c
source/blender/imbuf/intern/indexer.c
source/blender/imbuf/intern/indexer_dv.c
source/blender/makesdna/DNA_freestyle_types.h
source/blender/makesdna/DNA_linestyle_types.h
source/blender/modifiers/intern/MOD_meshcache_util.c
source/blender/render/intern/include/texture_ocean.h
source/blender/render/intern/source/texture_ocean.c
source/blender/windowmanager/intern/wm_playanim.c

index 26a160a..2bba968 100644 (file)
@@ -28,7 +28,9 @@
 #ifndef __BKE_DERIVEDMESH_H__
 #define __BKE_DERIVEDMESH_H__
 
-/**
+/** \file BKE_DerivedMesh.h
+ *  \ingroup bke
+ *
  * Basic design of the DerivedMesh system:
  *
  * DerivedMesh is a common set of interfaces for mesh systems.
index eafaec3..739a4e3 100644 (file)
 #ifndef __BKE_ADDON_H__
 #define __BKE_ADDON_H__
 
+/** \file BKE_addon.h
+ *  \ingroup bke
+ */
+
 #include "RNA_types.h"
 
 typedef struct bAddonPrefType {
index fb62115..7d5d423 100644 (file)
 #ifndef __BKE_CCG_H__
 #define __BKE_CCG_H__
 
+/** \file BKE_ccg.h
+ *  \ingroup bke
+ */
+
 /* defines BLI_INLINE */
 #include "BLI_utildefines.h"
 
index edfb501..738cd87 100644 (file)
 #ifndef __BKE_EDITMESH_H__
 #define __BKE_EDITMESH_H__
 
+/** \file BKE_editmesh.h
+ *  \ingroup bke
+ */
+
 #include "BKE_customdata.h"
 #include "bmesh.h"
 
index 862af16..9e73e06 100644 (file)
 #ifndef __BKE_MASK_H__
 #define __BKE_MASK_H__
 
+/** \file BKE_mask.h
+ *  \ingroup bke
+ */
+
 struct ImageUser;
 struct Image;
 struct ListBase;
index cc9c18c..3be363f 100644 (file)
 #ifndef __BKE_NAVMESH_CONVERSION_H__
 #define __BKE_NAVMESH_CONVERSION_H__
 
+/** \file BKE_navmesh_conversion.h
+ *  \ingroup bke
+ */
+
 struct DerivedMesh;
 
 /* navmesh_conversion.c */
index b733204..3facdfc 100644 (file)
 #ifndef __BKE_OCEAN_H__
 #define __BKE_OCEAN_H__
 
+/** \file BLI_ocean.h
+ *  \ingroup bli
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index ae6ec7c..129bc46 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenkernel/intern/addon.c
+ *  \ingroup bke
+ */
+
 #include <stddef.h>
 #include <stdlib.h>
 
index a6cff9f..580172b 100644 (file)
@@ -20,6 +20,9 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenkernel/intern/dynamicpaint.c
+ *  \ingroup bke
+ */
 
 #include "MEM_guardedalloc.h"
 
index 21a6991..c1e4336 100644 (file)
@@ -25,6 +25,9 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenkernel/intern/ocean.c
+ *  \ingroup bke
+ */
 
 #include <math.h>
 #include <stdlib.h>
index 29473fe..c83d760 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenkernel/intern/pbvh_bmesh.c
+ *  \ingroup bli
+ */
+
 #include "MEM_guardedalloc.h"
 
 #include "BLI_utildefines.h"
index 9af1c1d..0acf101 100644 (file)
 #ifndef __PBVH_INTERN_H__
 #define __PBVH_INTERN_H__
 
+/** \file blender/blenkernel/intern/pbvh_intern.c
+ *  \ingroup bli
+ */
+
 /* Axis-aligned bounding box */
 typedef struct {
        float bmin[3], bmax[3];
index 566fc95..4110c85 100644 (file)
@@ -13,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) 2008 Blender Foundation.
  * All rights reserved.
index 420ba16..bcdc97c 100644 (file)
 #ifndef __BLI_BITMAP_H__
 #define __BLI_BITMAP_H__
 
+/** \file BLI_bitmap.h
+ *  \ingroup bli
+ */
+
 typedef unsigned int BLI_bitmap;
 
 /* warning: the bitmap does not keep track of its own size or check
index 461b56e..9c4b4b0 100644 (file)
 #ifndef __BLI_BUFFER_H__
 #define __BLI_BUFFER_H__
 
-/* Note: this more or less fills same purpose as BLI_array, but makes
+/** \file BLI_buffer.h
+ *  \ingroup bli
+ *
+ * \note this more or less fills same purpose as BLI_array, but makes
  * it much easier to resize the array outside of the function it was
- * declared in since */
-
-/* Usage examples:
+ * declared in since.
  *
- * { 
- *     BLI_buffer_declare_static(int, my_int_array, BLI_BUFFER_NOP, 32);
+ * Usage examples:
+ * \code
+ * BLI_buffer_declare_static(int, my_int_array, BLI_BUFFER_NOP, 32);
  *
- *     BLI_buffer_append(my_int_array, int, 42);
- *     assert(my_int_array.count == 1);
- *     assert(BLI_buffer_at(my_int_array, int, 0) == 42);
+ * BLI_buffer_append(my_int_array, int, 42);
+ * assert(my_int_array.count == 1);
+ * assert(BLI_buffer_at(my_int_array, int, 0) == 42);
  *
- *     BLI_buffer_free(&my_int_array);
- * }
+ * BLI_buffer_free(&my_int_array);
+ * \endcode
  */
 
 typedef struct {
index 4f72777..8d5ea91 100644 (file)
@@ -18,7 +18,7 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file blender/blenlib/BLI_callbacks.h
+/** \file BLI_callbacks.h
  *  \ingroup bli
  */
 
index 543ff1b..c38c61a 100644 (file)
 #ifndef __BLI_MATH_INTERP__
 #define __BLI_MATH_INTERP__
 
+/** \file BLI_math_interp.h
+ *  \ingroup bli
+ */
+
 void BLI_bicubic_interpolation_fl(const float *buffer, float *output, int width, int height,
                                   int components, float u, float v);
 
index 510bf07..21d7a5a 100644 (file)
@@ -13,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) 2008 Blender Foundation.
  * All rights reserved.
index 36fb04a..4e57082 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenlib/intern/buffer.c
+ *  \ingroup bli
+ */
+
 #include "MEM_guardedalloc.h"
 
 #include "BLI_buffer.h"
index 614a9a6..719809e 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenlib/intern/callbacks.c
+ *  \ingroup bli
+ */
+
 #include "BLI_utildefines.h"
 #include "BLI_listbase.h"
 #include "BLI_callbacks.h"
index 536bb6d..5669a30 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenlib/intern/convexhull2d.c
+ *  \ingroup bli
+ */
+
+
 #include <stdlib.h>
 #include <string.h>
 
index 81d931c..d1acd45 100644 (file)
  *
  */
 
+/** \file blender/blenlib/intern/math_interp.c
+ *  \ingroup bli
+ */
+
 #include <math.h>
 
 #include "BLI_math.h"
index 7bb0747..19eb88f 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenlib/intern/smallhash.c
+ *  \ingroup bli
+ */
+
 #include <string.h>
 
 #include "MEM_guardedalloc.h"
index 3072863..b302ca7 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/bmesh/intern/bmesh_log.c
+ *  \ingroup bmesh
+ *
+ * The BMLog is an interface for storing undo/redo steps as a BMesh is
+ * modified. It only stores changes to the BMesh, not full copies.
+ *
+ * Currently it supports the following types of changes:
+ *
+ * - Adding and removing vertices
+ * - Adding and removing faces
+ * - Moving vertices
+ * - Setting vertex paint-mask values
+ * - Setting vertex hflags
+ */
+
 #include "MEM_guardedalloc.h"
 
 #include "BLI_utildefines.h"
index 4767c82..3cd2fd7 100644 (file)
 #ifndef __BMESH_LOG_H__
 #define __BMESH_LOG_H__
 
-/* The BMLog is an interface for storing undo/redo steps as a BMesh is
- * modified. It only stores changes to the BMesh, not full copies.
- *
- * Currently it supports the following types of changes:
- * 
- * - Adding and removing vertices
- * - Adding and removing faces
- * - Moving vertices
- * - Setting vertex paint-mask values
- * - Setting vertex hflags
+/** \file blender/bmesh/intern/bmesh_log.h
+ *  \ingroup bmesh
  */
 
 struct BMFace;
index 236d9af..4e49a9a 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/datatoc/datatoc.c
+ *  \ingroup datatoc
+ */
+
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
index d889ed1..83feed6 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/editors/mesh/mesh_navmesh.c
+ *  \ingroup edmesh
+ */
+
 #include "MEM_guardedalloc.h"
 
 #include "DNA_scene_types.h"
index 6f01086..568802d 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/editors/physics/dynamicpaint_ops.c
+ *  \ingroup edphys
+ */
+
 #include <math.h>
 #include <stdio.h>
 #include <string.h>
index 9d7cb05..ecfb4d4 100644 (file)
@@ -1,23 +1,22 @@
-
-//
-//  Copyright (C) : Please refer to the COPYRIGHT file distributed 
-//   with this source distribution. 
-//
-//  This program 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-//
-///////////////////////////////////////////////////////////////////////////////
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * This program 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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
 
 # include "TextStrokeRenderer.h"
 # include "Canvas.h"
index cd56f9d..42402f3 100644 (file)
@@ -1,3 +1,27 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * This program 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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/freestyle/intern/stroke/TextStrokeRenderer.h
+ *  \ingroup freestyle
+ */
+
 //
 //  Filename         : TextStrokeRenderer.h
 //  Author(s)        : Stephane Grabli
 //
 ///////////////////////////////////////////////////////////////////////////////
 
-
-//
-//  Copyright (C) : Please refer to the COPYRIGHT file distributed 
-//   with this source distribution. 
-//
-//  This program 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-//
-///////////////////////////////////////////////////////////////////////////////
-
-#ifndef  TEXTSTROKERENDERER_H
-# define TEXTSTROKERENDERER_H
+#ifndef TEXTSTROKERENDERER_H
+#define TEXTSTROKERENDERER_H
 
 # include "StrokeRenderer.h"
 # include "../system/FreestyleConfig.h"
index 3c93645..64a2bbb 100644 (file)
 #ifndef __IMB_COLORMANAGEMENT_H__
 #define __IMB_COLORMANAGEMENT_H__
 
+/** \file blender/imbuf/IMB_colormanagement.h
+ *  \ingroup imbuf
+ */
+
 #include "BLI_sys_types.h"
 
 #define BCM_CONFIG_FILE "config.ocio"
index eca441c..17eb4bf 100644 (file)
 #ifndef __IMB_COLORMANAGEMENT_INTERN_H__
 #define __IMB_COLORMANAGEMENT_INTERN_H__
 
+/** \file IMB_colormanagement_intern.h
+ *  \ingroup imbuf
+ */
+
 #include "DNA_listBase.h"
 #include "BLI_sys_types.h"
 
index 96f7a68..6173ffa 100644 (file)
 #ifndef __IMB_INDEXER_H__
 #define __IMB_INDEXER_H__
 
+/** \file IMB_indexer.h
+ *  \ingroup imbuf
+ */
+
 #ifdef WIN32
 #  include <io.h>
 #endif
index 9bc0b4d..4c4c82a 100644 (file)
  *
  */
 
+/** \file blender/imbuf/intern/colormanagement.c
+ *  \ingroup imbuf
+ */
+
 #include "IMB_colormanagement.h"
 #include "IMB_colormanagement_intern.h"
 
index 7acfe8a..dd0970a 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/imbuf/intern/indexer.c
+ *  \ingroup imbuf
+ */
+
 #include <stdlib.h>
 
 #include "MEM_guardedalloc.h"
index 7a8f8fc..4e8c13d 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/imbuf/intern/indexer_dv.c
+ *  \ingroup imbuf
+ */
+
 #include "MEM_guardedalloc.h"
 
 #include "BLI_utildefines.h"
index 738377b..db16fa3 100644 (file)
 #ifndef __DNA_FREESTYLE_TYPES_H__
 #define __DNA_FREESTYLE_TYPES_H__
 
+/** \file DNA_freestyle_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_listBase.h"
 
 #ifdef __cplusplus
index f5473d3..19c4e05 100644 (file)
 #ifndef __DNA_LINESTYLE_TYPES_H__
 #define __DNA_LINESTYLE_TYPES_H__
 
+/** \file DNA_linestyle_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_listBase.h"
 #include "DNA_ID.h"
 
index 679a793..404d053 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/modifiers/intern/MOD_meshcache_util.c
+ *  \ingroup modifiers
+ */
+
 #include "BLI_utildefines.h"
 #include "BLI_math.h"
 
index 121142a..4a71aff 100644 (file)
 #ifndef __TEXTURE_OCEAN_H__
 #define __TEXTURE_OCEAN_H__
 
+/** \file blender/render/intern/include/texture_ocean.h
+ *  \ingroup render
+ */
+
 int ocean_texture(struct Tex *tex, const float texvec[2], struct TexResult *texres);
 
 #endif  /* __TEXTURE_OCEAN_H__ */
index a754747..0d68c40 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenkernel/intern/texture_ocean.c
+ *  \ingroup bke
+ */
+
 #include <stddef.h>
 
 #include "BLI_math.h"
index e8ab1fe..a02fc75 100644 (file)
@@ -13,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.