Cleanup: use over-line for doxy comments

Follow our code style for doxygen sections.
This commit is contained in:
Campbell Barton 2020-10-27 21:32:09 +11:00
parent 30f626fe4c
commit 4b188bb08c
Notes: blender-bot 2023-02-14 09:03:55 +01:00
Referenced by issue #82141, compilation fails with openimageio-2.2.7.0
91 changed files with 178 additions and 197 deletions

View File

@ -1915,6 +1915,7 @@ void GHOST_SystemWin32::putClipboard(GHOST_TInt8 *buffer, bool selection) const
}
}
/* -------------------------------------------------------------------- */
/** \name Message Box
* \{ */
GHOST_TSuccess GHOST_SystemWin32::showMessageBox(const char *title,

View File

@ -2284,6 +2284,7 @@ void GHOST_SystemX11::putClipboard(GHOST_TInt8 *buffer, bool selection) const
}
}
/* -------------------------------------------------------------------- */
/** \name Message Box
* \{ */
class DialogData {

View File

@ -880,8 +880,7 @@ void BKE_node_tree_unlink_id(ID *id, struct bNodeTree *ntree);
* } FOREACH_NODETREE_END;
* \endcode
*
* \{
*/
* \{ */
/* should be an opaque type, only for internal use by BKE_node_tree_iter_*** */
struct NodeTreeIterStore {

View File

@ -35,6 +35,7 @@
/* interface */
#include "mikktspace.h"
/* -------------------------------------------------------------------- */
/** \name Tangent Space Calculation
* \{ */

View File

@ -899,8 +899,10 @@ struct Icon_Geom *BKE_icon_geom_from_file(const char *filename)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Studio Light Icon
* \{ */
int BKE_icon_ensure_studio_light(struct StudioLight *sl, int id_type)
{
int icon_id = get_next_free_id();

View File

@ -68,9 +68,7 @@ static size_t idp_size_table[] = {
};
/* -------------------------------------------------------------------- */
/* Array Functions */
/** \name IDP Array API
/** \name Array Functions (IDP Array API)
* \{ */
#define GETPROP(prop, i) &(IDP_IDPArray(prop)[i])
@ -323,9 +321,7 @@ static IDProperty *IDP_CopyArray(const IDProperty *prop, const int flag)
/** \} */
/* -------------------------------------------------------------------- */
/* String Functions */
/** \name IDProperty String API
/** \name String Functions (IDProperty String API)
* \{ */
/**
@ -439,9 +435,7 @@ void IDP_FreeString(IDProperty *prop)
/** \} */
/* -------------------------------------------------------------------- */
/* ID Type */
/** \name IDProperty ID API
/** \name ID Type (IDProperty ID API)
* \{ */
static IDProperty *IDP_CopyID(const IDProperty *prop, const int flag)
@ -477,9 +471,7 @@ void IDP_AssignID(IDProperty *prop, ID *id, const int flag)
/** \} */
/* -------------------------------------------------------------------- */
/* Group Functions */
/** \name IDProperty Group API
/** \name Group Functions (IDProperty Group API)
* \{ */
/**
@ -760,10 +752,9 @@ static void IDP_FreeGroup(IDProperty *prop, const bool do_id_user)
/** \} */
/* -------------------------------------------------------------------- */
/* Main Functions */
/** \name IDProperty Main API
/** \name Main Functions (IDProperty Main API)
* \{ */
IDProperty *IDP_CopyProperty_ex(const IDProperty *prop, const int flag)
{
switch (prop->type) {

View File

@ -36,6 +36,7 @@
* Utility functions for faster ID lookups.
*/
/* -------------------------------------------------------------------- */
/** \name BKE_main_idmap API
*
* Cache ID (name, library lookups).

View File

@ -327,6 +327,7 @@ void BKE_mesh_remap_find_best_match_from_mesh(const MVert *verts_dst,
/** \} */
/* -------------------------------------------------------------------- */
/** \name Mesh to mesh mapping
* \{ */

View File

@ -267,6 +267,7 @@ void BKE_mesh_batch_cache_free(Mesh *me)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Mesh runtime debug helpers.
* \{ */
/* evaluated mesh info printing function,

View File

@ -52,6 +52,7 @@
static CLG_LogRef LOG = {"bke.mesh"};
/* -------------------------------------------------------------------- */
/** \name Internal functions
* \{ */

View File

@ -51,6 +51,7 @@
#include "BKE_object.h"
#include "BKE_object_deform.h" /* own include */
/* -------------------------------------------------------------------- */
/** \name Misc helpers
* \{ */
@ -106,6 +107,7 @@ void BKE_object_defgroup_remap_update_users(Object *ob, const int *map)
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Group creation
* \{ */
@ -156,6 +158,7 @@ MDeformVert *BKE_object_defgroup_data_create(ID *id)
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Group clearing
* \{ */
@ -256,6 +259,7 @@ bool BKE_object_defgroup_clear_all(Object *ob, const bool use_selection)
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Group removal
* \{ */

View File

@ -63,6 +63,7 @@
static void pbvh_bmesh_verify(PBVH *pbvh);
#endif
/* -------------------------------------------------------------------- */
/** \name BMesh Utility API
*
* Use some local functions which assume triangles.

View File

@ -98,6 +98,7 @@ IDTypeInfo IDType_ID_WS = {
.blend_read_expand = NULL,
};
/* -------------------------------------------------------------------- */
/** \name Internal Utils
* \{ */

View File

@ -74,6 +74,7 @@ enum {
#endif
};
/* -------------------------------------------------------------------- */
/** \name GHash API
*
* Defined in ``BLI_ghash.c``
@ -124,6 +125,7 @@ void BLI_ghash_flag_clear(GHash *gh, unsigned int flag);
/** \} */
/* -------------------------------------------------------------------- */
/** \name GHash Iterator
* \{ */
@ -175,6 +177,7 @@ BLI_INLINE bool BLI_ghashIterator_done(GHashIterator *ghi)
/** \} */
/* -------------------------------------------------------------------- */
/** \name GSet API
* A 'set' implementation (unordered collection of unique elements).
*
@ -222,6 +225,7 @@ void *BLI_gset_pop_key(GSet *gs, const void *key) ATTR_WARN_UNUSED_RESULT;
/** \} */
/* -------------------------------------------------------------------- */
/** \name GSet Iterator
* \{ */
@ -272,6 +276,7 @@ BLI_INLINE bool BLI_gsetIterator_done(GSetIterator *gsi)
/** \} */
/* -------------------------------------------------------------------- */
/** \name GHash/GSet Debugging API's
* \{ */
@ -297,6 +302,7 @@ double BLI_gset_calc_quality(GSet *gs);
#endif /* GHASH_INTERNAL_API */
/** \} */
/* -------------------------------------------------------------------- */
/** \name GHash/GSet Macros
* \{ */
@ -324,6 +330,7 @@ double BLI_gset_calc_quality(GSet *gs);
/** \} */
/* -------------------------------------------------------------------- */
/** \name GHash/GSet Utils
*
* Defined in ``BLI_ghash_utils.c``

View File

@ -32,12 +32,9 @@
*/
/* -------------------------------------------------------------------- */
/* Linked Stack using BLI_mempool
*
* Uses mempool for storage.
*/
/** \name Linked Stack (mempool)
*
* Uses #BLI_mempool for storage.
* \{ */
#define BLI_LINKSTACK_DECLARE(var, type) \
@ -94,13 +91,12 @@
/** \} */
/* -------------------------------------------------------------------- */
/* Linked Stack, using stack memory (alloca)
/** \name Linked Stack (alloca)
*
* Linked Stack, using stack memory (alloca).
*
* alloca never frees, pop'd items are stored in a free-list for reuse.
* only use for lists small enough to fit on the stack.
*/
/** \name Linked Stack (alloca)
* \{ */
#ifdef __GNUC__

View File

@ -147,6 +147,7 @@ int BLI_string_find_split_words(const char *str,
int r_words[][2],
int words_max) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
/* -------------------------------------------------------------------- */
/** \name String Copy/Format Macros
* Avoid repeating destination with `sizeof(..)`.
* \note `ARRAY_SIZE` allows pointers on some platforms.

View File

@ -103,6 +103,7 @@ int BLI_str_utf8_offset_from_column(const char *str, int column);
#define BLI_UTF8_WIDTH_MAX 2 /* columns */
#define BLI_UTF8_ERR ((unsigned int)-1)
/* -------------------------------------------------------------------- */
/** \name String Copy/Format Macros
* Avoid repeating destination with `sizeof(..)`.
* \note `ARRAY_SIZE` allows pointers on some platforms.

View File

@ -67,6 +67,7 @@ struct Heap {
} nodes;
};
/* -------------------------------------------------------------------- */
/** \name Internal Functions
* \{ */
@ -146,6 +147,7 @@ static void heap_up(Heap *heap, uint i)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Internal Memory Management
* \{ */
@ -187,6 +189,7 @@ static void heap_node_free(Heap *heap, HeapNode *node)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Public Heap API
* \{ */

View File

@ -112,6 +112,7 @@
/* only for BLI_array_store_is_valid */
#include "BLI_ghash.h"
/* -------------------------------------------------------------------- */
/** \name Defines
*
* Some of the logic for merging is quite involved,
@ -206,6 +207,7 @@
/** \} */
/* -------------------------------------------------------------------- */
/** \name Internal Structs
* \{ */
@ -313,6 +315,7 @@ typedef struct BTableRef {
static size_t bchunk_list_size(const BChunkList *chunk_list);
/* -------------------------------------------------------------------- */
/** \name Internal BChunk API
* \{ */
@ -360,6 +363,7 @@ static bool bchunk_data_compare(const BChunk *chunk,
/** \} */
/* -------------------------------------------------------------------- */
/** \name Internal BChunkList API
* \{ */
@ -732,10 +736,11 @@ static void bchunk_list_fill_from_array(const BArrayInfo *info,
/** \} */
/* ---------------------------------------------------------------------------
/*
* Internal Table Lookup Functions
*/
/* -------------------------------------------------------------------- */
/** \name Internal Hashing/De-Duplication API
*
* Only used by #bchunk_list_from_data_merge
@ -1005,6 +1010,7 @@ static const BChunkRef *table_lookup(const BArrayInfo *info,
/** \} */
/* -------------------------------------------------------------------- */
/** \name Main Data De-Duplication Function
*
* \{ */
@ -1390,6 +1396,7 @@ static BChunkList *bchunk_list_from_data_merge(const BArrayInfo *info,
/** \} */
/* -------------------------------------------------------------------- */
/** \name Main Array Storage API
* \{ */
@ -1496,6 +1503,7 @@ void BLI_array_store_clear(BArrayStore *bs)
/** \} */
/* -------------------------------------------------------------------- */
/** \name BArrayStore Statistics
* \{ */
@ -1530,6 +1538,7 @@ size_t BLI_array_store_calc_size_compacted_get(const BArrayStore *bs)
/** \} */
/* -------------------------------------------------------------------- */
/** \name BArrayState Access
* \{ */
@ -1653,6 +1662,7 @@ void *BLI_array_store_state_data_get_alloc(BArrayState *state, size_t *r_data_le
/** \} */
/* -------------------------------------------------------------------- */
/** \name Debugging API (for testing).
* \{ */

View File

@ -97,6 +97,7 @@ BLI_INLINE int quad_flag(uint q)
#define TL 2
#define BR 3
/* -------------------------------------------------------------------- */
/** \name Box Accessor Functions
* \{ */
@ -121,6 +122,7 @@ static float box_ymax_get(const BoxPack *box)
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Box Placement
* \{ */
@ -165,6 +167,7 @@ static void box_ymax_set(BoxPack *box, const float f)
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Box Utils
* \{ */
@ -203,6 +206,7 @@ static void vert_bias_update(BoxVert *v)
printf("\tBox Debug i %i, w:%.3f h:%.3f x:%.3f y:%.3f\n", b->index, b->w, b->h, b->x, b->y)
#endif
/* -------------------------------------------------------------------- */
/** \name Box/Vert Sorting
* \{ */

View File

@ -37,6 +37,7 @@
* http://softsurfer.com/Archive/algorithm_0203/algorithm_0203.htm
*/
/* -------------------------------------------------------------------- */
/** \name Main Convex-Hull Calculation
* \{ */
@ -227,9 +228,9 @@ int BLI_convexhull_2d(const float (*points)[2], const int n, int r_points[])
/** \} */
/* -------------------------------------------------------------------- */
/* Helper functions */
/* -------------------------------------------------------------------- */
/** \name Utility Convex-Hull Functions
* \{ */

View File

@ -261,6 +261,7 @@ MINLINE void cpack_cpy_3ub(unsigned char r_col[3], const unsigned int pack)
r_col[2] = ((pack) >> 16) & 0xFF;
}
/* -------------------------------------------------------------------- */
/** \name RGB/Grayscale Functions
*
* \warning

View File

@ -4181,6 +4181,7 @@ int interp_sparse_array(float *array, const int list_size, const float skipval)
return 1;
}
/* -------------------------------------------------------------------- */
/** \name interp_weights_poly_v2, v3
* \{ */

View File

@ -535,8 +535,10 @@ void mul_m3_m4m4(float R[3][3], const float A[4][4], const float B[4][4])
R[2][2] = B[2][0] * A[0][2] + B[2][1] * A[1][2] + B[2][2] * A[2][2];
}
/* -------------------------------------------------------------------- */
/** \name Macro helpers for: mul_m3_series
* \{ */
void _va_mul_m3_series_3(float r[3][3], const float m1[3][3], const float m2[3][3])
{
mul_m3_m3m3(r, m1, m2);
@ -621,8 +623,10 @@ void _va_mul_m3_series_9(float r[3][3],
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Macro helpers for: mul_m4_series
* \{ */
void _va_mul_m4_series_3(float r[4][4], const float m1[4][4], const float m2[4][4])
{
mul_m4_m4m4(r, m1, m2);

View File

@ -162,6 +162,7 @@ void interp_v2_v2v2_slerp_safe(float target[2], const float a[2], const float b[
}
}
/* -------------------------------------------------------------------- */
/** \name Cubic curve interpolation (bezier spline).
* \{ */
@ -1395,6 +1396,7 @@ void copy_vn_fl(float *array_tar, const int size, const float val)
}
}
/* -------------------------------------------------------------------- */
/** \name Double precision versions 'db'.
* \{ */

View File

@ -1288,6 +1288,7 @@ MINLINE bool is_one_v3(const float v[3])
return (v[0] == 1.0f && v[1] == 1.0f && v[2] == 1.0f);
}
/* -------------------------------------------------------------------- */
/** \name Vector Comparison
*
* \note use ``value <= limit``, so a limit of zero doesn't fail on an exact match.
@ -1395,6 +1396,7 @@ MINLINE bool compare_size_v3v3(const float v1[3], const float v2[3], const float
return true;
}
/* -------------------------------------------------------------------- */
/** \name Vector Clamping
* \{ */

View File

@ -1085,9 +1085,9 @@ void print_rcti(const char *str, const rcti *rect)
BLI_rcti_size_y(rect));
}
/* -------------------------------------------------------------------- */
/* Comprehensive math (float only) */
/* -------------------------------------------------------------------- */
/** \name Rect math functions
* \{ */

View File

@ -349,6 +349,7 @@ void **BLI_smallhash_iternew_p(const SmallHash *sh, SmallHashIter *iter, uintptr
return BLI_smallhash_iternext_p(iter, key);
}
/* -------------------------------------------------------------------- */
/** \name Debugging & Introspection
* \{ */

View File

@ -2289,6 +2289,7 @@ bool BM_vert_splice(BMesh *bm, BMVert *v_dst, BMVert *v_src)
return true;
}
/* -------------------------------------------------------------------- */
/** \name BM_vert_separate, bmesh_kernel_vert_separate and friends
* \{ */

View File

@ -28,9 +28,9 @@
#include "bmesh.h"
#include "intern/bmesh_private.h"
/* -------------------------------------------------------------------- */
/* BMO functions */
/* -------------------------------------------------------------------- */
/** \name BMesh Operator Delete Functions
* \{ */
@ -203,7 +203,6 @@ void BMO_mesh_delete_oflag_context(BMesh *bm, const short oflag, const int type)
/** \} */
/* -------------------------------------------------------------------- */
/* BM functions
*
* note! this is just a duplicate of the code above (bad!)
@ -211,6 +210,7 @@ void BMO_mesh_delete_oflag_context(BMesh *bm, const short oflag, const int type)
* each time we need to remove some geometry.
*/
/* -------------------------------------------------------------------- */
/** \name BMesh Delete Functions (no oflags)
* \{ */

View File

@ -1027,6 +1027,7 @@ void BM_elem_float_data_set(CustomData *cd, void *element, int type, const float
}
}
/* -------------------------------------------------------------------- */
/** \name Loop interpolation functions: BM_vert_loop_groups_data_layer_***
*
* Handling loop custom-data such as UV's, while keeping contiguous fans is rather tedious.

View File

@ -66,6 +66,7 @@ static void recount_totsels(BMesh *bm)
}
}
/* -------------------------------------------------------------------- */
/** \name BMesh helper functions for selection & hide flushing.
* \{ */
@ -540,7 +541,8 @@ void BM_face_select_set(BMesh *bm, BMFace *f, const bool select)
}
}
/** \name Non flushing versions element selection.
/* -------------------------------------------------------------------- */
/** \name Non Flushing Versions Element Selection
* \{ */
void BM_edge_select_set_noflush(BMesh *bm, BMEdge *e, const bool select)

View File

@ -50,9 +50,7 @@ static BMEdge *bm_edge_copy_with_arrays(BMesh *bm_src,
}
static BMFace *bm_face_copy_with_arrays(
BMesh *bm_src, BMesh *bm_dst, BMFace *f_src, BMVert **verts_dst, BMEdge **edges_dst
)
BMesh *bm_src, BMesh *bm_dst, BMFace *f_src, BMVert **verts_dst, BMEdge **edges_dst)
{
BMFace *f_dst;
BMVert **vtar = BLI_array_alloca(vtar, f_src->len);

View File

@ -39,9 +39,9 @@
#include "intern/bmesh_private.h"
/* -------------------------------------------------------------------- */
/* Face Split Edge-Net */
/** \name BM_face_split_edgenet and helper functions.
/** \name Face Split Edge-Net
*
* #BM_face_split_edgenet and helper functions.
*
* \note Don't use #BM_edge_is_wire or #BM_edge_is_boundary
* since we need to take flagged faces into account.
@ -702,9 +702,9 @@ bool BM_face_split_edgenet(BMesh *bm,
/** \} */
/* -------------------------------------------------------------------- */
/* Face Split Edge-Net Connect Islands */
/** \name BM_face_split_edgenet_connect_islands and helper functions.
/** \name Face Split Edge-Net Connect Islands
*
* #BM_face_split_edgenet_connect_islands and helper functions.
*
* Connect isolated mesh 'islands' so they form legal regions from which we can create faces.
*

View File

@ -37,6 +37,7 @@
} \
(void)0
/* -------------------------------------------------------------------- */
/** \name Mask Flag Checks
* \{ */
@ -75,6 +76,7 @@ static bool bmw_mask_check_face(BMWalker *walker, BMFace *f)
/** \} */
/* -------------------------------------------------------------------- */
/** \name BMesh Queries (modified to check walker flags)
* \{ */
@ -94,8 +96,8 @@ static bool bmw_edge_is_wire(const BMWalker *walker, const BMEdge *e)
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Shell Walker
* \{
*
* Starts at a vertex on the mesh and walks over the 'shell' it belongs
* to via visiting connected edges.
@ -104,7 +106,7 @@ static bool bmw_edge_is_wire(const BMWalker *walker, const BMEdge *e)
* restrict flag acts on the edges as well.
*
* \todo Add restriction flag/callback for wire edges.
*/
* \{ */
static void bmw_VertShellWalker_visitEdge(BMWalker *walker, BMEdge *e)
{
BMwShellWalker *shellWalk = NULL;
@ -228,14 +230,14 @@ static void *bmw_VertShellWalker_step(BMWalker *walker)
/** \} */
/* -------------------------------------------------------------------- */
/** \name LoopShell Walker
* \{
*
* Starts at any element on the mesh and walks over the 'shell' it belongs
* to via visiting connected loops.
*
* \note this is mainly useful to loop over a shell delimited by edges.
*/
* \{ */
static void bmw_LoopShellWalker_visitLoop(BMWalker *walker, BMLoop *l)
{
BMwLoopShellWalker *shellWalk = NULL;
@ -352,10 +354,10 @@ static void *bmw_LoopShellWalker_step(BMWalker *walker)
/** \} */
/* -------------------------------------------------------------------- */
/** \name LoopShell & 'Wire' Walker
* \{
*
* Piggyback ontop of #BMwLoopShellWalker, but also walk over wire edges
* Piggyback on top of #BMwLoopShellWalker, but also walk over wire edges
* This isn't elegant but users expect it when selecting linked,
* so we can support delimiters _and_ walking over wire edges.
*
@ -363,7 +365,7 @@ static void *bmw_LoopShellWalker_step(BMWalker *walker)
* - can yield edges (as well as loops)
* - only step over wire edges.
* - verts and edges are stored in `visit_set_alt`.
*/
* \{ */
static void bmw_LoopShellWalker_visitEdgeWire(BMWalker *walker, BMEdge *e)
{
@ -504,12 +506,12 @@ static void *bmw_LoopShellWireWalker_step(BMWalker *walker)
/** \} */
/* -------------------------------------------------------------------- */
/** \name FaceShell Walker
* \{
*
* Starts at an edge on the mesh and walks over the 'shell' it belongs
* to via visiting connected faces.
*/
* \{ */
static void bmw_FaceShellWalker_visitEdge(BMWalker *walker, BMEdge *e)
{
BMwShellWalker *shellWalk = NULL;
@ -567,13 +569,13 @@ static void *bmw_FaceShellWalker_step(BMWalker *walker)
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Connected Vertex Walker
* \{
*
* Similar to shell walker, but visits vertices instead of edges.
*
* Walk from a vertex to all connected vertices.
*/
* \{ */
static void bmw_ConnectedVertexWalker_visitVertex(BMWalker *walker, BMVert *v)
{
BMwConnectedVertexWalker *vwalk;
@ -629,8 +631,8 @@ static void *bmw_ConnectedVertexWalker_step(BMWalker *walker)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Island Boundary Walker
* \{
*
* Starts at a edge on the mesh and walks over the boundary of an island it belongs to.
*
@ -640,7 +642,7 @@ static void *bmw_ConnectedVertexWalker_step(BMWalker *walker)
* over the boundary. raises an error if it encounters non-manifold geometry.
*
* \todo Add restriction flag/callback for wire edges.
*/
* \{ */
static void bmw_IslandboundWalker_begin(BMWalker *walker, void *data)
{
BMLoop *l = data;
@ -723,13 +725,13 @@ static void *bmw_IslandboundWalker_step(BMWalker *walker)
return owalk.curloop;
}
/* -------------------------------------------------------------------- */
/** \name Island Walker
* \{
*
* Starts at a tool flagged-face and walks over the face region
*
* \todo Add restriction flag/callback for wire edges.
*/
* \{ */
static void bmw_IslandWalker_begin(BMWalker *walker, void *data)
{
BMwIslandWalker *iwalk = NULL;
@ -828,11 +830,11 @@ static void *bmw_IslandManifoldWalker_step(BMWalker *walker)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Edge Loop Walker
* \{
*
* Starts at a tool-flagged edge and walks over the edge loop
*/
* \{ */
/* utility function to see if an edge is a part of an ngon boundary */
static bool bm_edge_is_single(BMEdge *e)
@ -1070,13 +1072,13 @@ static void *bmw_EdgeLoopWalker_step(BMWalker *walker)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Face Loop Walker
* \{
*
* Starts at a tool-flagged face and walks over the face loop
* Conditions for starting and stepping the face loop have been
* tuned in an attempt to match the face loops built by EditMesh
*/
* \{ */
/* Check whether the face loop should includes the face specified
* by the given BMLoop */
@ -1216,13 +1218,13 @@ static void *bmw_FaceLoopWalker_step(BMWalker *walker)
// #define BMW_EDGERING_NGON
/* -------------------------------------------------------------------- */
/** \name Edge Ring Walker
* \{
*
* Starts at a tool-flagged edge and walks over the edge ring
* Conditions for starting and stepping the edge ring have been
* tuned to match behavior users expect (dating back to v2.4x).
*/
* \{ */
static void bmw_EdgeringWalker_begin(BMWalker *walker, void *data)
{
BMwEdgeringWalker *lwalk, owalk, *owalk_pt;
@ -1349,6 +1351,7 @@ static void *bmw_EdgeringWalker_step(BMWalker *walker)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Boundary Edge Walker
* \{ */
@ -1420,14 +1423,14 @@ static void *bmw_EdgeboundaryWalker_step(BMWalker *walker)
/** \} */
/* -------------------------------------------------------------------- */
/** \name UV Edge Walker
*
* walk over uv islands; takes a loop as input. restrict flag
* restricts the walking to loops whose vert has restrict flag set as a
* tool flag.
*
* the flag parameter to BMW_init maps to a loop customdata layer index.
*
* The flag parameter to BMW_init maps to a loop customdata layer index.
* \{ */
static void bmw_UVEdgeWalker_begin(BMWalker *walker, void *data)

View File

@ -96,9 +96,7 @@ static void quad_verts_to_barycentric_tri(float tri[3][3],
#endif
/* -------------------------------------------------------------------- */
/* Handle Loop Pairs */
/** \name Loop Pairs
/** \name Handle Loop Pairs
* \{ */
/**

View File

@ -74,6 +74,7 @@ static bool bm_vert_pair_ends(BMVert *v_pivot, BMVert *v_end_pair[2])
}
#endif /* USE_EDGE_CHAIN */
/* -------------------------------------------------------------------- */
/** \name Vertex in Region Checks
* \{ */
@ -386,6 +387,7 @@ static LinkNode *mesh_calc_path_region_elem(BMesh *bm,
#undef USE_EDGE_CHAIN
/* -------------------------------------------------------------------- */
/** \name Main Functions (exposed externally).
* \{ */

View File

@ -72,6 +72,7 @@ static bool bm_loop_pair_ends(BMLoop *l_pivot, BMLoop *l_end_pair[2])
}
#endif /* USE_EDGE_CHAIN */
/* -------------------------------------------------------------------- */
/** \name Loop Vertex in Region Checks
* \{ */
@ -403,6 +404,7 @@ static LinkNode *mesh_calc_path_region_elem(BMesh *bm,
#undef USE_EDGE_CHAIN
/* -------------------------------------------------------------------- */
/** \name Main Functions (exposed externally).
* \{ */

View File

@ -67,8 +67,6 @@
#include "BLI_strict_flags.h"
/* -------------------------------------------------------------------- */
/* UUID-Walk API */
/** \name Internal UUIDWalk API
* \{ */
@ -615,6 +613,7 @@ static uint bm_uuidwalk_init_from_edge(UUIDWalk *uuidwalk, BMEdge *e)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Internal UUIDFaceStep API
* \{ */
@ -907,6 +906,7 @@ static void bm_face_array_visit(BMFace **faces,
#ifdef USE_PIVOT_SEARCH
/* -------------------------------------------------------------------- */
/** \name Internal UUIDWalk API
* \{ */
@ -1226,11 +1226,11 @@ static BMEdge *bm_face_region_pivot_edge_find(BMFace **faces_region,
#endif /* USE_PIVOT_SEARCH */
/* -------------------------------------------------------------------- */
/* Quick UUID pass - identify candidates */
#ifdef USE_PIVOT_FASTMATCH
/* -------------------------------------------------------------------- */
/** \name Fast Match
* \{ */

View File

@ -881,7 +881,6 @@ void EEVEE_materials_free(void)
}
/* -------------------------------------------------------------------- */
/** \name Render Passes
* \{ */

View File

@ -349,7 +349,6 @@ void EEVEE_shadows_draw(EEVEE_ViewLayerData *sldata, EEVEE_Data *vedata, DRWView
}
/* -------------------------------------------------------------------- */
/** \name Render Passes
* \{ */

View File

@ -788,7 +788,6 @@ void EEVEE_volumes_free(void)
}
/* -------------------------------------------------------------------- */
/** \name Render Passes
* \{ */

View File

@ -3026,6 +3026,7 @@ void DRW_render_context_disable(Render *render)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Init/Exit (DRW_opengl_ctx)
* \{ */
@ -3172,6 +3173,7 @@ void DRW_xr_drawing_end(void)
#endif
/* -------------------------------------------------------------------- */
/** \name Internal testing API for gtests
* \{ */

View File

@ -549,7 +549,6 @@ void DRW_shader_free(GPUShader *shader)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Shader Library
*
* Simple include system for glsl files.

View File

@ -198,7 +198,6 @@ void DRW_draw_cursor(void)
}
/* -------------------------------------------------------------------- */
/** \name 2D Cursor
* \{ */

View File

@ -1422,9 +1422,7 @@ void CURVE_OT_select_nth(wmOperatorType *ot)
}
/* -------------------------------------------------------------------- */
/* Select Similar */
/** \name Select Similar
/** \name Select Similar Operator
* \{ */
static const EnumPropertyItem curve_prop_similar_compare_types[] = {
@ -1786,9 +1784,7 @@ void CURVE_OT_select_similar(wmOperatorType *ot)
/** \} */
/* -------------------------------------------------------------------- */
/* Select Shortest Path */
/** \name Select Path
/** \name Select Shortest Path Operator
* \{ */
static float curve_calc_dist_pair(const Nurb *nu, int a, int b)

View File

@ -74,6 +74,7 @@ typedef struct UndoFont {
#ifdef USE_ARRAY_STORE
/* -------------------------------------------------------------------- */
/** \name Array Store
* \{ */

View File

@ -1581,6 +1581,7 @@ void ui_but_override_flag(Main *bmain, uiBut *but)
}
}
/* -------------------------------------------------------------------- */
/** \name Button Extra Operator Icons
*
* Extra icons are shown on the right hand side of buttons. They can be clicked to invoke custom

View File

@ -645,9 +645,9 @@ bool UI_but_online_manual_id_from_active(const struct bContext *C, char *r_str,
}
/* -------------------------------------------------------------------- */
/* Modal Button Store API */
/** \name Button Store
*
* Modal Button Store API.
*
* Store for modal operators & handlers to register button pointers
* which are maintained while drawing or NULL when removed.

View File

@ -121,11 +121,10 @@ static void edbm_intersect_select(BMEditMesh *em, struct Mesh *me, bool do_selec
}
/* -------------------------------------------------------------------- */
/* Cut intersections into geometry */
/** \name Simple Intersect (self-intersect)
* \{
*/
*
* Cut intersections into geometry.
* \{ */
enum {
ISECT_SEL = 0,
@ -331,15 +330,11 @@ void MESH_OT_intersect(struct wmOperatorType *ot)
/** \} */
/* -------------------------------------------------------------------- */
/* Boolean (a kind of intersect) */
/** \name Boolean Intersect
*
* \note internally this is nearly exactly the same as 'MESH_OT_intersect',
* however from a user perspective they are quite different, so expose as different tools.
*
* \{
*/
* \{ */
static int edbm_intersect_boolean_exec(bContext *C, wmOperator *op)
{
@ -488,9 +483,7 @@ void MESH_OT_intersect_boolean(struct wmOperatorType *ot)
/** \} */
/* -------------------------------------------------------------------- */
/* Face Split by Edges */
/** \name Face/Edge Split
/** \name Face Split by Edges
* \{ */
static void bm_face_split_by_edges(BMesh *bm,

View File

@ -118,6 +118,7 @@ typedef struct UndoMesh {
#ifdef USE_ARRAY_STORE
/* -------------------------------------------------------------------- */
/** \name Array Store
* \{ */

View File

@ -57,6 +57,7 @@
#include "screen_intern.h"
/* -------------------------------------------------------------------- */
/** \name Workspace API
*
* \brief API for managing workspaces and their data.
@ -231,6 +232,7 @@ void ED_workspace_scene_data_sync(WorkSpaceInstanceHook *hook, Scene *scene)
/** \} Workspace API */
/* -------------------------------------------------------------------- */
/** \name Workspace Operators
*
* \{ */

View File

@ -1159,6 +1159,7 @@ void SCULPT_floodfill_free(SculptFloodFill *flood)
flood->queue = NULL;
}
/* -------------------------------------------------------------------- */
/** \name Tool Capabilities
*
* Avoid duplicate checks, internal logic only,
@ -1380,6 +1381,7 @@ static void sculpt_project_v3_normal_align(SculptSession *ss,
grab_delta, ss->cache->sculpt_normal_symm, (len_signed * normal_weight) * len_view_scale);
}
/* -------------------------------------------------------------------- */
/** \name SculptProjectVector
*
* Fast-path for #project_plane_v3_v3v3
@ -1887,6 +1889,7 @@ static float calc_symmetry_feather(Sculpt *sd, StrokeCache *cache)
return 1.0f;
}
/* -------------------------------------------------------------------- */
/** \name Calculate Normal and Center
*
* Calculate geometry surrounding the brush center.
@ -3007,6 +3010,7 @@ static void do_mask_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int totnode)
}
}
/* -------------------------------------------------------------------- */
/** \name Sculpt Multires Displacement Eraser Brush
* \{ */
@ -3229,7 +3233,6 @@ static void do_draw_sharp_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int to
}
/* -------------------------------------------------------------------- */
/** \name Sculpt Topology Brush
* \{ */
@ -4765,7 +4768,6 @@ static void do_flatten_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int totno
}
/* -------------------------------------------------------------------- */
/** \name Sculpt Clay Brush
* \{ */
@ -5290,7 +5292,6 @@ static void do_scrape_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int totnod
}
/* -------------------------------------------------------------------- */
/** \name Sculpt Clay Thumb Brush
* \{ */

View File

@ -520,9 +520,7 @@ static void constraintSizeLim(TransInfo *t, TransData *td)
}
/* -------------------------------------------------------------------- */
/* Transform (Rotation Utils) */
/** \name Transform Rotation Utils
/** \name Transform (Rotation Utils)
* \{ */
/* Used by Transform Rotation and Transform Normal Rotation */
void headerRotation(TransInfo *t, char str[UI_MAX_DRAW_STR], float final)
@ -815,9 +813,7 @@ void ElementRotation(
/** \} */
/* -------------------------------------------------------------------- */
/* Transform (Resize Utils) */
/** \name Transform Resize Utils
/** \name Transform (Resize Utils)
* \{ */
void headerResize(TransInfo *t, const float vec[3], char str[UI_MAX_DRAW_STR])
{
@ -1040,9 +1036,7 @@ void ElementResize(TransInfo *t, TransDataContainer *tc, TransData *td, float ma
/** \} */
/* -------------------------------------------------------------------- */
/* Transform (Frame Utils) */
/** \name Transform Frame Utils
/** \name Transform (Frame Utils)
* \{ */
/**

View File

@ -35,9 +35,7 @@
#include "transform_mode.h"
/* -------------------------------------------------------------------- */
/* Transform (Align) */
/** \name Transform Align
/** \name Transform (Align)
* \{ */
static void applyAlign(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Bake-Time) */
/** \name Transform Bake-Time
/** \name Transform (Bake-Time)
* \{ */
static void applyBakeTime(TransInfo *t, const int mval[2])

View File

@ -41,9 +41,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (EditBone (B-bone) width scaling) */
/** \name Transform B-bone width scaling
/** \name Transform (EditBone B-Bone width scaling)
* \{ */
static void headerBoneSize(TransInfo *t, const float vec[3], char str[UI_MAX_DRAW_STR])

View File

@ -47,9 +47,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Bend) */
/** \name Transform Bend
/** \name Transform (Bend)
* \{ */
struct BendCustomData {

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Bone Envelope) */
/** \name Transform Bone Envelope
/** \name Transform (Bone Envelope)
* \{ */
static void applyBoneEnvelope(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (EditBone Roll) */
/** \name Transform EditBone Roll
/** \name Transform (EditBone Roll)
* \{ */
static void applyBoneRoll(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Curve Shrink/Fatten) */
/** \name Transform Curve Shrink/Fatten
/** \name Transform (Curve Shrink/Fatten)
* \{ */
static void applyCurveShrinkFatten(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Bevel Weight) */
/** \name Transform Bevel Weight
/** \name Transform (Bevel Weight)
* \{ */
static void applyBevelWeight(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Crease) */
/** \name Transform Crease
/** \name Transform (Crease)
* \{ */
static void applyCrease(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -39,9 +39,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Normal Rotation) */
/** \name Transform Normal Rotation
/** \name Transform (Normal Rotation)
* \{ */
static void storeCustomLNorValue(TransDataContainer *tc, BMesh *bm)

View File

@ -42,9 +42,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Sequencer Slide) */
/** \name Transform Sequencer Slide
/** \name Transform (Sequencer Slide)
* \{ */
static void headerSeqSlide(TransInfo *t, const float val[2], char str[UI_MAX_DRAW_STR])

View File

@ -56,9 +56,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Edge Slide) */
/** \name Transform Edge Slide
/** \name Transform (Edge Slide)
* \{ */
typedef struct TransDataEdgeSlideVert {

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (GPencil Opacity) */
/** \name Transform GPencil Strokes Opacity
/** \name Transform (GPencil Strokes Opacity)
* \{ */
static void applyGPOpacity(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (GPencil Shrink/Fatten) */
/** \name Transform GPencil Strokes Shrink/Fatten
/** \name Transform (GPencil Strokes Shrink/Fatten)
* \{ */
static void applyGPShrinkFatten(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Mask Shrink/Fatten) */
/** \name Transform Mask Shrink/Fatten
/** \name Transform (Mask Shrink/Fatten)
* \{ */
static void applyMaskShrinkFatten(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -38,9 +38,7 @@
#include "transform_mode.h"
/* -------------------------------------------------------------------- */
/* Transform (Mirror) */
/** \name Transform Mirror
/** \name Transform (Mirror)
* \{ */
static void applyMirror(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -41,9 +41,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Push/Pull) */
/** \name Transform Push/Pull
/** \name Transform (Push/Pull)
* \{ */
static void applyPushPull(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -39,9 +39,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Resize) */
/** \name Transform Resize
/** \name Transform (Resize)
* \{ */
static float ResizeBetween(TransInfo *t, const float p1[3], const float p2[3])

View File

@ -37,9 +37,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Rotation) */
/** \name Transform Rotation
/** \name Transform (Rotation)
* \{ */
static float RotationBetween(TransInfo *t, const float p1[3], const float p2[3])

View File

@ -44,9 +44,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Shear) */
/** \name Transform Shear
/** \name Transform (Shear)
* \{ */
static void initShear_mouseInputMode(TransInfo *t)

View File

@ -42,9 +42,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Shrink-Fatten) */
/** \name Transform Shrink-Fatten
/** \name Transform (Shrink-Fatten)
* \{ */
static void applyShrinkFatten(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -38,9 +38,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Skin) */
/** \name Transform Skin
/** \name Transform (Skin)
* \{ */
static void applySkinResize(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Tilt) */
/** \name Transform Tilt
/** \name Transform (Tilt)
* \{ */
static void applyTilt(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -42,9 +42,7 @@
#include "transform_mode.h"
/* -------------------------------------------------------------------- */
/* Transform (Animation Time Scale) */
/** \name Transform Animation Time Scale
/** \name Transform (Animation Time Scale)
* \{ */
static void headerTimeScale(TransInfo *t, char str[UI_MAX_DRAW_STR])

View File

@ -45,9 +45,7 @@
#include "transform_mode.h"
/* -------------------------------------------------------------------- */
/* Transform (Animation Time Slide) */
/** \name Transform Animation Time Slide
/** \name Transform (Animation Time Slide)
* \{ */
static void headerTimeSlide(TransInfo *t, const float sval, char str[UI_MAX_DRAW_STR])

View File

@ -43,9 +43,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Animation Translation) */
/** \name Transform Animation Translation
/** \name Transform (Animation Translation)
* \{ */
static void headerTimeTranslate(TransInfo *t, char str[UI_MAX_DRAW_STR])

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (ToSphere) */
/** \name Transform ToSphere
/** \name Transform (ToSphere)
* \{ */
static void applyToSphere(TransInfo *t, const int UNUSED(mval[2]))

View File

@ -40,9 +40,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Rotation - Trackball) */
/** \name Transform Rotation - Trackball
/** \name Transform (Rotation - Trackball)
* \{ */
static void applyTrackballValue(TransInfo *t,

View File

@ -49,9 +49,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Translation) */
/** \name Transform Translation
/** \name Transform (Translation)
* \{ */
static void headerTranslation(TransInfo *t, const float vec[3], char str[UI_MAX_DRAW_STR])

View File

@ -53,9 +53,7 @@
#include "transform_snap.h"
/* -------------------------------------------------------------------- */
/* Transform (Vert Slide) */
/** \name Transform Vert Slide
/** \name Transform (Vert Slide)
* \{ */
typedef struct TransDataVertSlideVert {

View File

@ -126,6 +126,7 @@ static void info_callback(const char *msg, void *client_data)
} \
(void)0
/* -------------------------------------------------------------------- */
/** \name Buffer Stream
* \{ */
@ -217,6 +218,7 @@ static opj_stream_t *opj_stream_create_from_buffer(struct BufInfo *p_file,
/** \} */
/* -------------------------------------------------------------------- */
/** \name File Stream
* \{ */

View File

@ -558,6 +558,7 @@ static StructRNA *rna_Gizmo_refine(PointerRNA *mnp_ptr)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Gizmo Group API
* \{ */

View File

@ -611,6 +611,7 @@ void WM_gizmo_calc_matrix_final(const wmGizmo *gz, float r_mat[4][4])
r_mat);
}
/* -------------------------------------------------------------------- */
/** \name Gizmo Property Access
*
* Matches `WM_operator_properties` conventions.
@ -755,6 +756,7 @@ void WM_gizmo_properties_free(PointerRNA *ptr)
/** \} */
/* -------------------------------------------------------------------- */
/** \name General Utilities
*
* \{ */

View File

@ -344,6 +344,7 @@ bool wm_gizmogroup_is_any_selected(const wmGizmoGroup *gzgroup)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Gizmo operators
*
* Basic operators for gizmo interaction with user configurable keymaps.

View File

@ -38,6 +38,7 @@
#include "wm_gizmo_intern.h"
#include "wm_gizmo_wmapi.h"
/* -------------------------------------------------------------------- */
/** \name GizmoGroup Type Append
*
* \note This follows conventions from #WM_operatortype_find #WM_operatortype_append & friends.

View File

@ -45,6 +45,7 @@
#include "wm_gizmo_intern.h"
#include "wm_gizmo_wmapi.h"
/* -------------------------------------------------------------------- */
/** \name Gizmo Type Append
*
* \note This follows conventions from #WM_operatortype_find #WM_operatortype_append & friends.

View File

@ -95,6 +95,7 @@ void WM_operatortype_iter(GHashIterator *ghi)
BLI_ghashIterator_init(ghi, global_ops_hash);
}
/* -------------------------------------------------------------------- */
/** \name Operator Type Append
* \{ */