[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [44060] branches/bmesh/blender/source/ blender: style cleanup for bmesh headers

Campbell Barton ideasman42 at gmail.com
Sun Feb 12 15:40:18 CET 2012 

Revision: 44060
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=44060
Author:   campbellbarton
Date:     2012-02-12 14:40:08 +0000 (Sun, 12 Feb 2012)
Log Message:
-----------
style cleanup for bmesh headers
- use consistant header guards
- correct doxy comments
- remove ED_toolmode.h (unused)

Modified Paths:
--------------
    branches/bmesh/blender/source/blender/blenkernel/BKE_tessmesh.h
    branches/bmesh/blender/source/blender/blenkernel/intern/bmesh_private.h
    branches/bmesh/blender/source/blender/blenlib/BLI_smallhash.h
    branches/bmesh/blender/source/blender/blenlib/BLI_sparsemap.h
    branches/bmesh/blender/source/blender/bmesh/bmesh.h
    branches/bmesh/blender/source/blender/bmesh/bmesh_class.h
    branches/bmesh/blender/source/blender/bmesh/bmesh_error.h
    branches/bmesh/blender/source/blender/bmesh/bmesh_iterators.h
    branches/bmesh/blender/source/blender/bmesh/bmesh_marking.h
    branches/bmesh/blender/source/blender/bmesh/bmesh_operator_api.h
    branches/bmesh/blender/source/blender/bmesh/bmesh_operators.h
    branches/bmesh/blender/source/blender/bmesh/bmesh_queries.h
    branches/bmesh/blender/source/blender/bmesh/bmesh_walkers.h
    branches/bmesh/blender/source/blender/bmesh/intern/bmesh_operators_private.h
    branches/bmesh/blender/source/blender/bmesh/intern/bmesh_private.h
    branches/bmesh/blender/source/blender/bmesh/intern/bmesh_structure.h
    branches/bmesh/blender/source/blender/bmesh/intern/bmesh_walkers_private.h
    branches/bmesh/blender/source/blender/bmesh/operators/bmo_subdivide.h
    branches/bmesh/blender/source/blender/editors/mesh/editbmesh_bvh.h
    branches/bmesh/blender/source/blender/editors/util/CMakeLists.txt
    branches/bmesh/blender/source/blender/makesrna/intern/rna_mesh_utils.h

Removed Paths:
-------------
    branches/bmesh/blender/source/blender/editors/include/ED_toolmode.h

Modified: branches/bmesh/blender/source/blender/blenkernel/BKE_tessmesh.h
===================================================================
--- branches/bmesh/blender/source/blender/blenkernel/BKE_tessmesh.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/blenkernel/BKE_tessmesh.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -1,6 +1,28 @@
-#ifndef _BKE_TESSMESH_H
-#define _BKE_TESSMESH_H
+/*
+ * ***** 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.
+ *
+ * Contributor(s): Joseph Eagar.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
 
+#ifndef __BKE_TESSMESH_H__
+#define __BKE_TESSMESH_H__
+
 #include "bmesh.h"
 
 struct BMesh;
@@ -72,4 +94,4 @@
 void BMEdit_Free(BMEditMesh *em);
 void BMEdit_UpdateLinkedCustomData(BMEditMesh *em);
 
-#endif /* _BKE_TESSMESH_H */
+#endif /* __BKE_TESSMESH_H__ */

Modified: branches/bmesh/blender/source/blender/blenkernel/intern/bmesh_private.h
===================================================================
--- branches/bmesh/blender/source/blender/blenkernel/intern/bmesh_private.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/blenkernel/intern/bmesh_private.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -30,15 +30,12 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file blender/blenkernel/intern/bmesh_private.h
- *  \ingroup bke
- */
-
-
 #ifndef BMESH_PRIVATE
 #define BMESH_PRIVATE
 
-#include "BKE_bmesh.h"
+/** \file blender/bmesh/bmesh_private.h
+ *  \ingroup bmesh
+ */
 
 /*ALLOCATION/DEALLOCATION*/
 struct BME_Vert *BME_addvertlist(struct BME_Mesh *bm, struct BME_Vert *example);

Modified: branches/bmesh/blender/source/blender/blenlib/BLI_smallhash.h
===================================================================
--- branches/bmesh/blender/source/blender/blenlib/BLI_smallhash.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/blenlib/BLI_smallhash.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -25,8 +25,8 @@
  * ***** END GPL LICENSE BLOCK *****
  */
  
-#ifndef BLI_SMALLHASH_H
-#define BLI_SMALLHASH_H
+#ifndef __BLI_SMALLHASH_H__
+#define __BLI_SMALLHASH_H__
 
 /** \file BLI_smallhash.h
  *  \ingroup bli
@@ -70,4 +70,4 @@
 void *	BLI_smallhash_iternew(SmallHash *hash, SmallHashIter *iter, uintptr_t *key);
 /* void BLI_smallhash_print(SmallHash *hash); */ /* UNUSED */
 
-#endif // BLI_SMALLHASH_H
+#endif /* __BLI_SMALLHASH_H__ */

Modified: branches/bmesh/blender/source/blender/blenlib/BLI_sparsemap.h
===================================================================
--- branches/bmesh/blender/source/blender/blenlib/BLI_sparsemap.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/blenlib/BLI_sparsemap.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -24,6 +24,13 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
+#ifndef __BLI_SPARSEMAP_H__
+#define __BLI_SPARSEMAP_H__
+
+/** \file BLI_sparsemap.h
+ *  \ingroup bli
+ */
+
 #include "BLI_math_inline.h"
 
 typedef struct SparseMap {
@@ -68,4 +75,7 @@
 	
 	sm->blocks[index/sm->blocksize] = ptr;
 }
+
+#endif /* __BLI_SPARSEMAP_H__ */
+
 #endif

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh.h
===================================================================
--- branches/bmesh/blender/source/blender/bmesh/bmesh.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/bmesh/bmesh.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -1,6 +1,4 @@
 /*
- *	BMesh API.
- *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
@@ -22,9 +20,13 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef BMESH_H
-#define BMESH_H
+#ifndef __BMESH_H__
+#define __BMESH_H__
 
+/** \file blender/bmesh/bmesh.h
+ *  \ingroup bmesh
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -368,4 +370,4 @@
 }
 #endif
 
-#endif /* BMESH_H */
+#endif /* __BMESH_H__ */

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh_class.h
===================================================================
--- branches/bmesh/blender/source/blender/bmesh/bmesh_class.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/bmesh/bmesh_class.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -20,11 +20,15 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef _BMESH_CLASS_H
-#define _BMESH_CLASS_H
+#ifndef __BMESH_CLASS_H__
+#define __BMESH_CLASS_H__
 
-/*bmesh data structures*/
+/** \file blender/bmesh/bmesh_class.h
+ *  \ingroup bmesh
+ */
 
+/* bmesh data structures */
+
 struct BMesh;
 struct BMVert;
 struct BMEdge;
@@ -158,4 +162,4 @@
 #define BM_LOOP		4
 #define BM_FACE		8
 
-#endif /* _BMESH_CLASS_H */
+#endif /* __BMESH_CLASS_H__ */

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh_error.h
===================================================================
--- branches/bmesh/blender/source/blender/bmesh/bmesh_error.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/bmesh/bmesh_error.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -20,9 +20,13 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef _BMESH_ERROR_H
-#define _BMESH_ERROR_H
+#ifndef __BMESH_ERROR_H__
+#define __BMESH_ERROR_H__
 
+/** \file blender/bmesh/bmesh_error.h
+ *  \ingroup bmesh
+ */
+
 /*----------- bmop error system ----------*/
 
 /* pushes an error onto the bmesh error stack.
@@ -65,4 +69,4 @@
 #define BMERR_INVALID_SELECTION			9
 #define BMERR_MESH_ERROR				10
 
-#endif /* _BMESH_ERROR_H */
+#endif /* __BMESH_ERROR_H__ */

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh_iterators.h
===================================================================
--- branches/bmesh/blender/source/blender/bmesh/bmesh_iterators.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/bmesh/bmesh_iterators.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -20,6 +20,13 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
+#ifndef __BMESH_ITERATORS_H__
+#define __BMESH_ITERATORS_H__
+
+/** \file blender/bmesh/bmesh_iterators.h
+ *  \ingroup bmesh
+ */
+
 /*
  * BMESH ITERATORS
  *
@@ -32,9 +39,6 @@
  *
 */
 
-#ifndef BM_ITERATORS_H
-#define BM_ITERATORS_H
-
 #include "BLI_mempool.h"
 
 /* Defines for passing to BM_iter_new.
@@ -129,4 +133,4 @@
 
 #include "intern/bmesh_iterators_inline.c"
 
-#endif
+#endif /* __BMESH_ITERATORS_H__ */

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh_marking.h
===================================================================
--- branches/bmesh/blender/source/blender/bmesh/bmesh_marking.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/bmesh/bmesh_marking.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -20,9 +20,13 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef BM_MARKING_H
-#define BM_MARKING_H
+#ifndef __BMESH_MARKING_H__
+#define __BMESH_MARKING_H__
 
+/** \file blender/bmesh/bmesh_marking.h
+ *  \ingroup bmesh
+ */
+
 typedef struct BMEditSelection
 {
 	struct BMEditSelection *next, *prev;
@@ -69,4 +73,4 @@
 void BM_select_history_validate(BMesh *bm);
 void BM_select_history_clear(BMesh *em);
 
-#endif
+#endif /* __BMESH_MARKING_H__ */

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh_operator_api.h
===================================================================
--- branches/bmesh/blender/source/blender/bmesh/bmesh_operator_api.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/bmesh/bmesh_operator_api.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -20,9 +20,13 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef _BMESH_OPERATOR_API_H
-#define _BMESH_OPERATOR_API_H
+#ifndef __BMESH_OPERATOR_API_H__
+#define __BMESH_OPERATOR_API_H__
 
+/** \file blender/bmesh/bmesh_operator_api.h
+ *  \ingroup bmesh
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -549,4 +553,4 @@
 }
 #endif
 
-#endif /* _BMESH_OPERATOR_API_H */
+#endif /* __BMESH_OPERATOR_API_H__ */

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh_operators.h
===================================================================
--- branches/bmesh/blender/source/blender/bmesh/bmesh_operators.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/bmesh/bmesh_operators.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -20,9 +20,13 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef _BMESH_OPERATORS_H
-#define _BMESH_OPERATORS_H
+#ifndef __BMESH_OPERATORS_H__
+#define __BMESH_OPERATORS_H__
 
+/** \file blender/bmesh/bmesh_operators.h
+ *  \ingroup bmesh
+ */
+
 /*see comments in intern/bmesh_opdefines.c for documentation of specific operators*/
 
 /*--------defines/enumerations for specific operators-------*/
@@ -98,4 +102,4 @@
                        float fractal, int beauty, int numcuts, int seltype,
                        int cornertype, int singleedge, int gridfill, int seed);
 
-#endif
+#endif /* __BMESH_OPERATORS_H__ */

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh_queries.h
===================================================================
--- branches/bmesh/blender/source/blender/bmesh/bmesh_queries.h	2012-02-12 12:07:02 UTC (rev 44059)
+++ branches/bmesh/blender/source/blender/bmesh/bmesh_queries.h	2012-02-12 14:40:08 UTC (rev 44060)
@@ -20,8 +20,13 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef BMESH_QUERIES_H
-#define BMESH_QUERIES_H
+#ifndef __BMESH_QUERIES_H__
+#define __BMESH_QUERIES_H__
+
+/** \file blender/bmesh/bmesh_queries.h
+ *  \ingroup bmesh
+ */
+
 #include <stdio.h>
 
 /* Queries */
@@ -113,4 +118,4 @@
  * edges in the face.*/
 void BM_face_legal_splits(BMesh *bm, BMFace *f, BMLoop *(*loops)[2], int len);
 
-#endif
+#endif /* __BMESH_QUERIES_H__ */

Modified: branches/bmesh/blender/source/blender/bmesh/bmesh_walkers.h
===================================================================

@@ Diff output truncated at 10240 characters. @@

More information about the Bf-blender-cvs mailing list