bartvdbraak/blender
1
0
Fork 4
Code Issues 4 Pull Requests 1 Actions 1 Packages Projects Releases Wiki Activity

style cleanup: use <pre> for doxygen ascii art

Browse Source
This commit is contained in:
Campbell Barton 2012-08-13 15:17:15 +00:00
parent 39945fedf3
commit ca7d1ec39d
12 changed files with 78 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
build_files/cmake/cmake_netbeans_project.py
View File

@ -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
"""

4
source/blender/bmesh/intern/bmesh_construct.c
View File

@ -539,8 +539,8 @@ void BMO_remove_tagged_verts(BMesh *bm, const short oflag)
}
}
/*************************************************************/
/* you need to make remove tagged verts/edges/faces
/**
* 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.
* This is because the BM_remove_taggedXXX functions bypass iterator API.

12
source/blender/bmesh/intern/bmesh_core.c
View File

@ -1134,7 +1134,7 @@ static BMFace *bm_face_create__sfme(BMesh *bm, BMFace *UNUSED(example))
* The second region has a new face assigned to it.
*
* \par Examples:
*
* <pre>
* Before: After:
* +--------+ +--------+
* | | | |
@ -1143,6 +1143,7 @@ static BMFace *bm_face_create__sfme(BMesh *bm, BMFace *UNUSED(example))
* | | | 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 @@ BMFace *bmesh_sfme(BMesh *bm, BMFace *f, BMVert *v1, BMVert *v2,
* 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 @@ BMVert *bmesh_semv(BMesh *bm, BMVert *tv, BMEdge *e, BMEdge **r_e)
* and collapses the edge on that vertex.
*
* \par Examples:
*
* <pre>
* Before: OE KE
* ------- -------
* | || |
@ -1485,6 +1487,7 @@ BMVert *bmesh_semv(BMesh *bm, BMVert *tv, BMEdge *e, BMEdge **r_e)
* ---------------
* | |
* OV TV
* </pre>
*
* \par Restrictions:
* KV is a vertex that must have a valance of exactly two. Furthermore
@ -1636,7 +1639,7 @@ BMEdge *bmesh_jekv(BMesh *bm, BMEdge *ke, BMVert *kv, const short check_edge_dou
* Both faces in its radial cycle
*
* \par Examples:
*
* <pre>
* A B
* +--------+ +--------+
* | | | |
@ -1645,6 +1648,7 @@ BMEdge *bmesh_jekv(BMesh *bm, BMEdge *ke, BMVert *kv, const short check_edge_dou
* | 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.

3
source/blender/bmesh/intern/bmesh_interp.c
View File

@ -186,7 +186,7 @@ void BM_face_interp_from_face(BMesh *bm, BMFace *target, BMFace *source)
* \brief Multires Interpolation
*
* mdisps is a grid of displacements, ordered thus:
*
* <pre>
* v1/center----v4/next -> x
* | |
* | |
@ -194,6 +194,7 @@ void BM_face_interp_from_face(BMesh *bm, BMFace *target, BMFace *source)
* |
* 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])

7
source/blender/bmesh/intern/bmesh_mods.c
View File

@ -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).

11
source/blender/bmesh/intern/bmesh_queries.c
View File

@ -54,7 +54,7 @@ int BM_vert_in_edge(BMEdge *e, BMVert *v)
* \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 @@ int BM_vert_in_edge(BMEdge *e, BMVert *v)
* ^ ^ <------- 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 @@ BMLoop *BM_face_other_edge_loop(BMFace *f, BMEdge *e, BMVert *v)
* 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 @@ BMLoop *BM_face_other_edge_loop(BMFace *f, BMEdge *e, BMVert *v)
* ^^^^^^ ^ <-- 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 @@ BMLoop *BM_face_other_vert_loop(BMFace *f, BMVert *v_prev, BMVert *v)
* \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 @@ BMLoop *BM_face_other_vert_loop(BMFace *f, BMVert *v_prev, BMVert *v)
* ^ <------- 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)

4
source/blender/bmesh/intern/bmesh_structure.c
View File

@ -203,9 +203,9 @@ void bmesh_disk_edge_remove(BMEdge *e, BMVert *v)
/**
* \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)
{

38
source/blender/bmesh/operators/bmo_subdivide.c
View File

@ -269,13 +269,15 @@ static void bm_subdivide_multicut(BMesh *bm, BMEdge *edge, const SubDParams *par
* match the input geometry. they're based on the
* pre-split state of the face */
/*
/**
* <pre>
* v3---------v2
* | |
* | |
* | |
* | |
* v4---v0---v1
* </pre>
*/
static void quad_1edge_split(BMesh *bm, BMFace *UNUSED(face),
BMVert **verts, const SubDParams *params)
@ -313,13 +315,15 @@ static SubDPattern quad_1edge = {
};
/*
/**
* <pre>
* v6--------v5
* | |
* | |v4s
* | |v3s
* | s s |
* v7-v0--v1-v2
* </pre>
*/
static void quad_2edge_split_path(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@ -339,13 +343,15 @@ static SubDPattern quad_2edge_path = {
4,
};
/*
/**
* <pre>
* v6--------v5
* | |
* | |v4s
* | |v3s
* | s s |
* v7-v0--v1-v2
* </pre>
*/
static void quad_2edge_split_innervert(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@ -379,14 +385,15 @@ static SubDPattern quad_2edge_innervert = {
4,
};
/*
/**
* <pre>
* v6--------v5
* | |
* | |v4s
* | |v3s
* | s s |
* v7-v0--v1-v2
*
* </pre>
*/
static void quad_2edge_split_fan(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@ -409,7 +416,8 @@ static SubDPattern quad_2edge_fan = {
4,
};
/*
/**
* <pre>
* s s
* v8--v7--v6-v5
* | |
@ -418,6 +426,7 @@ static SubDPattern quad_2edge_fan = {
* | v3 s
* | s s |
* v9-v0--v1-v2
* </pre>
*/
static void quad_3edge_split(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@ -446,7 +455,8 @@ static SubDPattern quad_3edge = {
4,
};
/*
/**
* <pre>
* v8--v7-v6--v5
* | s |
* |v9 s s|v4
@ -455,6 +465,7 @@ static SubDPattern quad_3edge = {
* v11-v0--v1-v2
*
* it goes from bottom up
* </pre>
*/
static void quad_4edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@ -525,7 +536,8 @@ static void quad_4edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts
MEM_freeN(lines);
}
/*
/**
* <pre>
* v3
* / \
* / \
@ -534,6 +546,7 @@ static void quad_4edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts
* / \
* v4--v0--v1--v2
* s s
* </pre>
*/
static void tri_1edge_split(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@ -552,7 +565,9 @@ static SubDPattern tri_1edge = {
3,
};
/* v5
/**
* <pre>
* v5
* / \
* s v6/---\ v4 s
* / \ / \
@ -560,6 +575,7 @@ static SubDPattern tri_1edge = {
* / \/ \/ \
* v8--v0--v1--v2
* s s
* </pre>
*/
static void tri_3edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@ -610,7 +626,8 @@ static void tri_3edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
}
}
/*
/**
* <pre>
* v5
* / \
* s v6/---\ v4 s
@ -619,6 +636,7 @@ static void tri_3edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
* / \/ \/ \
* v8--v0--v1--v2
* s s
* </pre>
*/
for (i = 1; i < numcuts + 1; i++) {
for (j = 0; j < i; j++) {

15
source/blender/bmesh/tools/BME_bevel.c
View File

@ -1029,17 +1029,16 @@ static BMesh *BME_bevel_reinitialize(BMesh *bm)
#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,

12
source/blender/makesdna/DNA_object_types.h
View File

@ -71,16 +71,17 @@ typedef struct bDeformGroup {
#define DG_LOCK_WEIGHT 1
/**
* The following illustrates the orientation of the
* The following illustrates the orientation of the
* bounding box in local space
*
*
*
* <pre>
*
* Z Y
* | /
* |/
* .-----X
*
*
*
*
* 2----------6
* /| /|
* / | / |
@ -90,6 +91,7 @@ typedef struct bDeformGroup {
* | / | /
* |/ |/
* 0----------4
* </pre>
*/
typedef struct BoundBox {
float vec[8][3];

2
source/blender/render/intern/source/pixelblending.c
View File

@ -233,6 +233,7 @@ void mask_array(unsigned int mask, float filt[][3])
/**
* Index ordering, scanline based:
*
* <pre>
* --- --- ---
* | 2,0 | 2,1 | 2,2 |
* --- --- ---
@ -240,6 +241,7 @@ void mask_array(unsigned int mask, float filt[][3])
* --- --- ---
* | 0,0 | 0,1 | 0,2 |
* --- --- ---
* </pre>
*/
void add_filt_fmask_coord(float filt[][3], const float col[4], float *rowbuf, int row_w, int col_h, int x, int y)

14
source/blender/windowmanager/WM_types.h
View File

@ -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 @@
* +-----------------------------+ |
* | |
* +------------------------------+
* </pre>
*
* A common way to get the space from the ScrArea:
*
* <pre>
* if (sa->spacetype == SPACE_VIEW3D) {
* View3D *v3d = sa->spacedata.first;
* ...
* }
*
* </pre>
*/
#ifdef __cplusplus