[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [60059] trunk/blender/source/blender: code cleanup: headers - doxy comments.
Campbell Barton
ideasman42 at gmail.com
Thu Sep 12 05:02:53 CEST 2013
Revision: 60059
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=60059
Author: campbellbarton
Date: 2013-09-12 03:02:50 +0000 (Thu, 12 Sep 2013)
Log Message:
-----------
code cleanup: headers - doxy comments.
Modified Paths:
--------------
trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h
trunk/blender/source/blender/blenkernel/BKE_addon.h
trunk/blender/source/blender/blenkernel/BKE_ccg.h
trunk/blender/source/blender/blenkernel/BKE_editmesh.h
trunk/blender/source/blender/blenkernel/BKE_mask.h
trunk/blender/source/blender/blenkernel/BKE_navmesh_conversion.h
trunk/blender/source/blender/blenkernel/BKE_ocean.h
trunk/blender/source/blender/blenkernel/intern/addon.c
trunk/blender/source/blender/blenkernel/intern/dynamicpaint.c
trunk/blender/source/blender/blenkernel/intern/ocean.c
trunk/blender/source/blender/blenkernel/intern/pbvh_bmesh.c
trunk/blender/source/blender/blenkernel/intern/pbvh_intern.h
trunk/blender/source/blender/blenlib/BLI_array.h
trunk/blender/source/blender/blenlib/BLI_bitmap.h
trunk/blender/source/blender/blenlib/BLI_buffer.h
trunk/blender/source/blender/blenlib/BLI_callbacks.h
trunk/blender/source/blender/blenlib/BLI_math_interp.h
trunk/blender/source/blender/blenlib/intern/BLI_array.c
trunk/blender/source/blender/blenlib/intern/buffer.c
trunk/blender/source/blender/blenlib/intern/callbacks.c
trunk/blender/source/blender/blenlib/intern/convexhull2d.c
trunk/blender/source/blender/blenlib/intern/math_interp.c
trunk/blender/source/blender/blenlib/intern/smallhash.c
trunk/blender/source/blender/bmesh/intern/bmesh_log.c
trunk/blender/source/blender/bmesh/intern/bmesh_log.h
trunk/blender/source/blender/datatoc/datatoc.c
trunk/blender/source/blender/editors/mesh/mesh_navmesh.c
trunk/blender/source/blender/editors/physics/dynamicpaint_ops.c
trunk/blender/source/blender/freestyle/intern/stroke/TextStrokeRenderer.cpp
trunk/blender/source/blender/freestyle/intern/stroke/TextStrokeRenderer.h
trunk/blender/source/blender/imbuf/IMB_colormanagement.h
trunk/blender/source/blender/imbuf/intern/IMB_colormanagement_intern.h
trunk/blender/source/blender/imbuf/intern/IMB_indexer.h
trunk/blender/source/blender/imbuf/intern/colormanagement.c
trunk/blender/source/blender/imbuf/intern/indexer.c
trunk/blender/source/blender/imbuf/intern/indexer_dv.c
trunk/blender/source/blender/makesdna/DNA_freestyle_types.h
trunk/blender/source/blender/makesdna/DNA_linestyle_types.h
trunk/blender/source/blender/modifiers/intern/MOD_meshcache_util.c
trunk/blender/source/blender/render/intern/include/texture_ocean.h
trunk/blender/source/blender/render/intern/source/texture_ocean.c
trunk/blender/source/blender/windowmanager/intern/wm_playanim.c
Modified: trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -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.
Modified: trunk/blender/source/blender/blenkernel/BKE_addon.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_addon.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/BKE_addon.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -22,6 +22,10 @@
#ifndef __BKE_ADDON_H__
#define __BKE_ADDON_H__
+/** \file BKE_addon.h
+ * \ingroup bke
+ */
+
#include "RNA_types.h"
typedef struct bAddonPrefType {
Modified: trunk/blender/source/blender/blenkernel/BKE_ccg.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_ccg.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/BKE_ccg.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -28,6 +28,10 @@
#ifndef __BKE_CCG_H__
#define __BKE_CCG_H__
+/** \file BKE_ccg.h
+ * \ingroup bke
+ */
+
/* defines BLI_INLINE */
#include "BLI_utildefines.h"
Modified: trunk/blender/source/blender/blenkernel/BKE_editmesh.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_editmesh.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/BKE_editmesh.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -23,6 +23,10 @@
#ifndef __BKE_EDITMESH_H__
#define __BKE_EDITMESH_H__
+/** \file BKE_editmesh.h
+ * \ingroup bke
+ */
+
#include "BKE_customdata.h"
#include "bmesh.h"
Modified: trunk/blender/source/blender/blenkernel/BKE_mask.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_mask.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/BKE_mask.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -28,6 +28,10 @@
#ifndef __BKE_MASK_H__
#define __BKE_MASK_H__
+/** \file BKE_mask.h
+ * \ingroup bke
+ */
+
struct ImageUser;
struct Image;
struct ListBase;
Modified: trunk/blender/source/blender/blenkernel/BKE_navmesh_conversion.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_navmesh_conversion.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/BKE_navmesh_conversion.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -28,6 +28,10 @@
#ifndef __BKE_NAVMESH_CONVERSION_H__
#define __BKE_NAVMESH_CONVERSION_H__
+/** \file BKE_navmesh_conversion.h
+ * \ingroup bke
+ */
+
struct DerivedMesh;
/* navmesh_conversion.c */
Modified: trunk/blender/source/blender/blenkernel/BKE_ocean.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_ocean.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/BKE_ocean.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -23,6 +23,10 @@
#ifndef __BKE_OCEAN_H__
#define __BKE_OCEAN_H__
+/** \file BLI_ocean.h
+ * \ingroup bli
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
Modified: trunk/blender/source/blender/blenkernel/intern/addon.c
===================================================================
--- trunk/blender/source/blender/blenkernel/intern/addon.c 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/intern/addon.c 2013-09-12 03:02:50 UTC (rev 60059)
@@ -20,6 +20,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
+/** \file blender/blenkernel/intern/addon.c
+ * \ingroup bke
+ */
+
#include <stddef.h>
#include <stdlib.h>
Modified: trunk/blender/source/blender/blenkernel/intern/dynamicpaint.c
===================================================================
--- trunk/blender/source/blender/blenkernel/intern/dynamicpaint.c 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/intern/dynamicpaint.c 2013-09-12 03:02:50 UTC (rev 60059)
@@ -20,6 +20,9 @@
* ***** END GPL LICENSE BLOCK *****
*/
+/** \file blender/blenkernel/intern/dynamicpaint.c
+ * \ingroup bke
+ */
#include "MEM_guardedalloc.h"
Modified: trunk/blender/source/blender/blenkernel/intern/ocean.c
===================================================================
--- trunk/blender/source/blender/blenkernel/intern/ocean.c 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/intern/ocean.c 2013-09-12 03:02:50 UTC (rev 60059)
@@ -25,6 +25,9 @@
* ***** END GPL LICENSE BLOCK *****
*/
+/** \file blender/blenkernel/intern/ocean.c
+ * \ingroup bke
+ */
#include <math.h>
#include <stdlib.h>
Modified: trunk/blender/source/blender/blenkernel/intern/pbvh_bmesh.c
===================================================================
--- trunk/blender/source/blender/blenkernel/intern/pbvh_bmesh.c 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/intern/pbvh_bmesh.c 2013-09-12 03:02:50 UTC (rev 60059)
@@ -18,6 +18,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
+/** \file blender/blenkernel/intern/pbvh_bmesh.c
+ * \ingroup bli
+ */
+
#include "MEM_guardedalloc.h"
#include "BLI_utildefines.h"
Modified: trunk/blender/source/blender/blenkernel/intern/pbvh_intern.h
===================================================================
--- trunk/blender/source/blender/blenkernel/intern/pbvh_intern.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenkernel/intern/pbvh_intern.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -21,6 +21,10 @@
#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];
Modified: trunk/blender/source/blender/blenlib/BLI_array.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_array.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenlib/BLI_array.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -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.
Modified: trunk/blender/source/blender/blenlib/BLI_bitmap.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_bitmap.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenlib/BLI_bitmap.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -26,6 +26,10 @@
#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
Modified: trunk/blender/source/blender/blenlib/BLI_buffer.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_buffer.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenlib/BLI_buffer.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -21,21 +21,23 @@
#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 {
Modified: trunk/blender/source/blender/blenlib/BLI_callbacks.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_callbacks.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenlib/BLI_callbacks.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -18,7 +18,7 @@
* ***** END GPL LICENSE BLOCK *****
*/
-/** \file blender/blenlib/BLI_callbacks.h
+/** \file BLI_callbacks.h
* \ingroup bli
*/
Modified: trunk/blender/source/blender/blenlib/BLI_math_interp.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_math_interp.h 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenlib/BLI_math_interp.h 2013-09-12 03:02:50 UTC (rev 60059)
@@ -29,6 +29,10 @@
#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);
Modified: trunk/blender/source/blender/blenlib/intern/BLI_array.c
===================================================================
--- trunk/blender/source/blender/blenlib/intern/BLI_array.c 2013-09-12 01:41:16 UTC (rev 60058)
+++ trunk/blender/source/blender/blenlib/intern/BLI_array.c 2013-09-12 03:02:50 UTC (rev 60059)
@@ -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.
*
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list