[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [49873] trunk/blender: style cleanup: use <pre> for doxygen ascii art
Campbell Barton
ideasman42 at gmail.com
Mon Aug 13 17:17:15 CEST 2012
Revision: 49873
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=49873
Author: campbellbarton
Date: 2012-08-13 15:17:15 +0000 (Mon, 13 Aug 2012)
Log Message:
-----------
style cleanup: use <pre> for doxygen ascii art
Modified Paths:
--------------
trunk/blender/build_files/cmake/cmake_netbeans_project.py
trunk/blender/source/blender/bmesh/intern/bmesh_construct.c
trunk/blender/source/blender/bmesh/intern/bmesh_core.c
trunk/blender/source/blender/bmesh/intern/bmesh_interp.c
trunk/blender/source/blender/bmesh/intern/bmesh_mods.c
trunk/blender/source/blender/bmesh/intern/bmesh_queries.c
trunk/blender/source/blender/bmesh/intern/bmesh_structure.c
trunk/blender/source/blender/bmesh/tools/BME_bevel.c
trunk/blender/source/blender/windowmanager/WM_types.h
Modified: trunk/blender/build_files/cmake/cmake_netbeans_project.py
===================================================================
--- trunk/blender/build_files/cmake/cmake_netbeans_project.py 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/build_files/cmake/cmake_netbeans_project.py 2012-08-13 15:17:15 UTC (rev 49873)
@@ -24,7 +24,7 @@
"""
Example linux usage
- python .~/blenderSVN/blender/build_files/cmake/cmake_netbeans_project.py ~/blenderSVN/cmake
+ python3 ~/blenderSVN/blender/build_files/cmake/cmake_netbeans_project.py ~/blenderSVN/cmake
Windows not supported so far
"""
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_construct.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_construct.c 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_construct.c 2012-08-13 15:17:15 UTC (rev 49873)
@@ -539,7 +539,7 @@
}
}
-/*************************************************************/
+/**
/* you need to make remove tagged verts/edges/faces
* api functions that take a filter callback.....
* and this new filter type will be for opstack flags.
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_core.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_core.c 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_core.c 2012-08-13 15:17:15 UTC (rev 49873)
@@ -1134,7 +1134,7 @@
* The second region has a new face assigned to it.
*
* \par Examples:
- *
+ * <pre>
* Before: After:
* +--------+ +--------+
* | | | |
@@ -1143,6 +1143,7 @@
* | | | f2 |
* | | | |
* +--------+ +--------+
+ * </pre>
*
* \note the input vertices can be part of the same edge. This will
* result in a two edged face. This is desirable for advanced construction
@@ -1302,12 +1303,13 @@
* will be attached to that end and is returned in \a r_e.
*
* \par Examples:
- *
+ * <pre>
* E
* Before: OV-------------TV
*
* E RE
* After: OV------NV-----TV
+ * </pre>
*
* \return The newly created BMVert pointer.
*/
@@ -1474,7 +1476,7 @@
* and collapses the edge on that vertex.
*
* \par Examples:
- *
+ * <pre>
* Before: OE KE
* ------- -------
* | || |
@@ -1485,6 +1487,7 @@
* ---------------
* | |
* OV TV
+ * </pre>
*
* \par Restrictions:
* KV is a vertex that must have a valance of exactly two. Furthermore
@@ -1636,7 +1639,7 @@
* Both faces in its radial cycle
*
* \par Examples:
- *
+ * <pre>
* A B
* +--------+ +--------+
* | | | |
@@ -1645,6 +1648,7 @@
* | f2 | | f2 |
* | | | |
* +--------+ +--------+
+ * </pre>
*
* In the example A, faces \a f1 and \a f2 are joined by a single edge,
* and the euler can safely be used.
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_interp.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_interp.c 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_interp.c 2012-08-13 15:17:15 UTC (rev 49873)
@@ -186,7 +186,7 @@
* \brief Multires Interpolation
*
* mdisps is a grid of displacements, ordered thus:
- *
+ * <pre>
* v1/center----v4/next -> x
* | |
* | |
@@ -194,6 +194,7 @@
* |
* V
* y
+ * </pre>
*/
static int compute_mdisp_quad(BMLoop *l, float v1[3], float v2[3], float v3[3], float v4[3],
float e1[3], float e2[3])
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_mods.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_mods.c 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_mods.c 2012-08-13 15:17:15 UTC (rev 49873)
@@ -45,20 +45,21 @@
* Turns the face region surrounding a manifold vertex into a single polygon.
*
* \par Example:
- *
+ * <pre>
* +---------+ +---------+
* | \ / | | |
* Before: | v | After: | |
* | / \ | | |
* +---------+ +---------+
+ * </pre>
*
- *
* This function can also collapse edges too
* in cases when it cant merge into faces.
*
* \par Example:
- *
+ * <pre>
* Before: +----v----+ After: +---------+
+ * </pre>
*
* \note dissolves vert, in more situations then BM_disk_dissolve
* (e.g. if the vert is part of a wire edge, etc).
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_queries.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_queries.c 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_queries.c 2012-08-13 15:17:15 UTC (rev 49873)
@@ -54,7 +54,7 @@
* \brief Other Loop in Face Sharing an Edge
*
* Finds the other loop that shares \a v with \a e loop in \a f.
- *
+ * <pre>
* +----------+
* | |
* | f |
@@ -64,7 +64,7 @@
* ^ ^ <------- These vert args define direction
* in the face to check.
* The faces loop direction is ignored.
- *
+ * </pre>
*/
BMLoop *BM_face_other_edge_loop(BMFace *f, BMEdge *e, BMVert *v)
{
@@ -92,8 +92,7 @@
* This function returns a loop in \a f that shares an edge with \a v
* The direction is defined by \a v_prev, where the return value is
* the loop of what would be 'v_next'
- *
- *
+ * <pre>
* +----------+ <-- return the face loop of this vertex.
* | |
* | f |
@@ -103,6 +102,7 @@
* ^^^^^^ ^ <-- These vert args define direction
* in the face to check.
* The faces loop direction is ignored.
+ * </pre>
*
* \note \a v_prev and \a v _implicitly_ define an edge.
*/
@@ -143,7 +143,7 @@
* \brief Other Loop in Face Sharing a Vert
*
* Finds the other loop that shares \a v with \a e loop in \a f.
- *
+ * <pre>
* +----------+ <-- return the face loop of this vertex.
* | |
* | |
@@ -153,6 +153,7 @@
* ^ <------- This loop defines both the face to search
* and the edge, in combination with 'v'
* The faces loop direction is ignored.
+ * </pre>
*/
BMLoop *BM_loop_other_vert_loop(BMLoop *l, BMVert *v)
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_structure.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_structure.c 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_structure.c 2012-08-13 15:17:15 UTC (rev 49873)
@@ -203,9 +203,9 @@
/**
* \brief Next Disk Edge
*
- * Find the next edge in a disk cycle
+ * Find the next edge in a disk cycle
*
- * \return Pointer to the next edge in the disk cycle for the vertex v.
+ * \return Pointer to the next edge in the disk cycle for the vertex v.
*/
BMEdge *bmesh_disk_edge_next(BMEdge *e, BMVert *v)
{
Modified: trunk/blender/source/blender/bmesh/tools/BME_bevel.c
===================================================================
--- trunk/blender/source/blender/bmesh/tools/BME_bevel.c 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/source/blender/bmesh/tools/BME_bevel.c 2012-08-13 15:17:15 UTC (rev 49873)
@@ -1029,17 +1029,16 @@
#endif
/**
- * BME_bevel_mesh
+ * BME_bevel_mesh
*
- * Mesh beveling tool:
+ * Mesh beveling tool:
*
- * Bevels an entire mesh. It currently uses the flags of
- * its vertices and edges to track topological changes.
- * The parameter "value" is the distance to inset (should be negative).
- * The parameter "options" is not currently used.
+ * Bevels an entire mesh. It currently uses the flags of
+ * its vertices and edges to track topological changes.
+ * The parameter "value" is the distance to inset (should be negative).
+ * The parameter "options" is not currently used.
*
- * Returns -
- * A BMesh pointer to the BM passed as a parameter.
+ * \return A BMesh pointer to the BM passed as a parameter.
*/
static BMesh *BME_bevel_mesh(BMesh *bm, float value, int UNUSED(res), int options,
Modified: trunk/blender/source/blender/windowmanager/WM_types.h
===================================================================
--- trunk/blender/source/blender/windowmanager/WM_types.h 2012-08-13 14:51:39 UTC (rev 49872)
+++ trunk/blender/source/blender/windowmanager/WM_types.h 2012-08-13 15:17:15 UTC (rev 49873)
@@ -31,10 +31,11 @@
#ifndef __WM_TYPES_H__
#define __WM_TYPES_H__
-/*
+/**
* Overview of WM structs
* ======================
*
+ * <pre>
* > wmWindowManager (window manager stores a list of windows)
* > > wmWindow (window has an active screen)
* > > > bScreen (link to ScrAreas via 'areabase')
@@ -42,11 +43,12 @@
* > > > > > SpaceLink (base struct for space data for all different space types)
* > > > > ScrArea (stores multiple regions via 'regionbase')
* > > > > > ARegion
+ * </pre>
*
- *
* Window Layout
* =============
*
+ * <pre>
* wmWindow -> bScreen
* +----------------------------------------------------------+
* |+-----------------------------------------+-------------+ |
@@ -66,11 +68,12 @@
* ||+-------++----------+-------------------+| | |
* |+-----------------------------------------+-------------+ |
* +----------------------------------------------------------+
+ * </pre>
*
- *
* Space Data
* ==========
*
+ * <pre>
* ScrArea's store a list of space data (SpaceLinks), each of unique type.
* The first one is the displayed in the UI, others are added as needed.
*
@@ -88,14 +91,15 @@
* +-----------------------------+ |
* | |
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list