forked from bartvdbraak/blender
Cleanup: doxygen comments
This commit is contained in:
parent
81c199af83
commit
bf8f5f5142
2
extern/curve_fit_nd/intern/generic_heap.c
vendored
2
extern/curve_fit_nd/intern/generic_heap.c
vendored
@ -305,3 +305,5 @@ void *HEAP_node_ptr(HeapNode *node)
|
||||
{
|
||||
return node->ptr;
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
@ -573,7 +573,6 @@ void BKE_node_preview_set_pixel(struct bNodePreview *preview, const f
|
||||
|
||||
/** \} */
|
||||
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Node Type Access
|
||||
* \{ */
|
||||
@ -603,6 +602,7 @@ void node_type_gpu(struct bNodeType *ntype, NodeGPUExecFunction gpufu
|
||||
void node_type_internal_links(struct bNodeType *ntype, void (*update_internal_links)(struct bNodeTree *, struct bNode *));
|
||||
void node_type_compatibility(struct bNodeType *ntype, short compatibility);
|
||||
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Node Generic Functions
|
||||
@ -692,7 +692,7 @@ bool BKE_node_tree_iter_step(struct NodeTreeIterStore *ntreeiter,
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Shader Nodes
|
||||
*/
|
||||
* \{ */
|
||||
struct ShadeInput;
|
||||
struct ShadeResult;
|
||||
|
||||
@ -816,7 +816,7 @@ void ntreeGPUMaterialNodes(struct bNodeTree *ntree, struct GPUMateria
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Composite Nodes
|
||||
*/
|
||||
* \{ */
|
||||
|
||||
/* output socket defines */
|
||||
#define RRES_OUT_IMAGE 0
|
||||
@ -1000,7 +1000,7 @@ void ntreeCompositColorBalanceSyncFromCDL(bNodeTree *ntree, bNode *node);
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Texture Nodes
|
||||
*/
|
||||
* \{ */
|
||||
|
||||
struct TexResult;
|
||||
|
||||
|
@ -2533,6 +2533,7 @@ void BKE_mesh_calc_volume(
|
||||
}
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
||||
|
@ -199,6 +199,8 @@ void BLI_gset_clear(GSet *gs, GSetKeyFreeFP keyfreefp);
|
||||
void *BLI_gset_lookup(GSet *gh, const void *key) ATTR_WARN_UNUSED_RESULT;
|
||||
void *BLI_gset_pop_key(GSet *gs, const void *key) ATTR_WARN_UNUSED_RESULT;
|
||||
|
||||
/** \} */
|
||||
|
||||
/** \name GSet Iterator
|
||||
* \{ */
|
||||
|
||||
@ -286,7 +288,7 @@ double BLI_gset_calc_quality(GSet *gs);
|
||||
*
|
||||
* \note '_p' suffix denotes void pointer arg,
|
||||
* so we can have functions that take correctly typed args too.
|
||||
* \{ */
|
||||
*/
|
||||
|
||||
unsigned int BLI_ghashutil_ptrhash(const void *key);
|
||||
bool BLI_ghashutil_ptrcmp(const void *a, const void *b);
|
||||
|
@ -1345,7 +1345,7 @@ void *BLI_gset_lookup(GSet *gs, const void *key)
|
||||
|
||||
/**
|
||||
* Returns the pointer to the key if it's found, removing it from the GSet.
|
||||
* \node Caller must handle freeing.
|
||||
* \note Caller must handle freeing.
|
||||
*/
|
||||
void *BLI_gset_pop_key(GSet *gs, const void *key)
|
||||
{
|
||||
|
@ -1924,6 +1924,7 @@ void BLI_bvhtree_ray_cast_all(
|
||||
BLI_bvhtree_ray_cast_all_ex(tree, co, dir, radius, hit_dist, callback, userdata, BVH_RAYCAST_DEFAULT);
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
||||
|
@ -299,7 +299,7 @@ typedef struct BChunk {
|
||||
} BChunk;
|
||||
|
||||
/**
|
||||
* Links to store #BChunk data in #BChunkList.chunks.
|
||||
* Links to store #BChunk data in #BChunkList.chunk_refs.
|
||||
*/
|
||||
typedef struct BChunkRef {
|
||||
struct BChunkRef *next, *prev;
|
||||
@ -749,6 +749,7 @@ static void bchunk_list_fill_from_array(
|
||||
ASSERT_CHUNKLIST_DATA(chunk_list, data);
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* ---------------------------------------------------------------------------
|
||||
* Internal Table Lookup Functions
|
||||
@ -1013,6 +1014,10 @@ static const BChunkRef *table_lookup(
|
||||
|
||||
/** \} */
|
||||
|
||||
/** \name Main Data De-Duplication Function
|
||||
*
|
||||
* \{ */
|
||||
|
||||
/**
|
||||
* \param data: Data to store in the returned value.
|
||||
* \param data_len_original: Length of data in bytes.
|
||||
@ -1504,6 +1509,8 @@ void BLI_array_store_clear(
|
||||
BLI_mempool_clear(bs->memory.chunk);
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/** \name BArrayStore Statistics
|
||||
* \{ */
|
||||
|
||||
|
@ -265,7 +265,8 @@ static void polyedge_rotate(
|
||||
struct HalfEdge *e)
|
||||
{
|
||||
/** CCW winding, rotate internal edge to new vertical state.
|
||||
* <pre>
|
||||
*
|
||||
* \code{.unparsed}
|
||||
* Before After
|
||||
* X X
|
||||
* / \ /|\
|
||||
@ -276,7 +277,7 @@ static void polyedge_rotate(
|
||||
* e2\ /e1 e2\ | /e1
|
||||
* \ / \|/
|
||||
* X X
|
||||
* </pre>
|
||||
* \endcode
|
||||
*/
|
||||
struct HalfEdge *ed[6];
|
||||
uint ed_index[6];
|
||||
|
@ -208,7 +208,7 @@ size_t BLI_strcpy_rlen(char *__restrict dst, const char *__restrict src)
|
||||
}
|
||||
|
||||
/**
|
||||
* Portable replacement for #vsnprintf
|
||||
* Portable replacement for `vsnprintf`.
|
||||
*/
|
||||
size_t BLI_vsnprintf(char *__restrict buffer, size_t maxncpy, const char *__restrict format, va_list arg)
|
||||
{
|
||||
@ -503,7 +503,7 @@ int BLI_strcaseeq(const char *a, const char *b)
|
||||
}
|
||||
|
||||
/**
|
||||
* Portable replacement for #strcasestr (not available in MSVC)
|
||||
* Portable replacement for `strcasestr` (not available in MSVC)
|
||||
*/
|
||||
char *BLI_strcasestr(const char *s, const char *find)
|
||||
{
|
||||
|
@ -1310,11 +1310,11 @@ static void parallel_mempool_func(
|
||||
/**
|
||||
* This function allows to parallelize for loops over Mempool items.
|
||||
*
|
||||
* \param pool The iterable BLI_mempool to loop over.
|
||||
* \param userdata Common userdata passed to all instances of \a func.
|
||||
* \param func Callback function.
|
||||
* \param use_threading If \a true, actually split-execute loop in threads, else just do a sequential forloop
|
||||
* (allows caller to use any kind of test to switch on parallelization or not).
|
||||
* \param mempool: The iterable BLI_mempool to loop over.
|
||||
* \param userdata: Common userdata passed to all instances of \a func.
|
||||
* \param func: Callback function.
|
||||
* \param use_threading: If \a true, actually split-execute loop in threads, else just do a sequential for loop
|
||||
* (allows caller to use any kind of test to switch on parallelization or not).
|
||||
*
|
||||
* \note There is no static scheduling here.
|
||||
*/
|
||||
|
@ -521,7 +521,7 @@ void BM_verts_calc_normal_vcos(BMesh *bm, const float (*fnos)[3], const float (*
|
||||
}
|
||||
|
||||
/**
|
||||
* Helpers for #BM_mesh_loop_normals_update and #BM_loops_calc_normals_vnos
|
||||
* Helpers for #BM_mesh_loop_normals_update and #BM_loops_calc_normal_vcos
|
||||
*/
|
||||
static void bm_mesh_edges_sharp_tag(
|
||||
BMesh *bm,
|
||||
|
@ -860,7 +860,7 @@ static void bvhtree_test_edges_isect_2d_ray_cb(
|
||||
/**
|
||||
* Store values for:
|
||||
* - #bm_face_split_edgenet_find_connection
|
||||
* - #test_edges_isect_2d
|
||||
* - #test_edges_isect_2d_vert
|
||||
* ... which don't change each call.
|
||||
*/
|
||||
struct EdgeGroup_FindConnection_Args {
|
||||
|
@ -1526,9 +1526,9 @@ float BM_loop_calc_face_angle(const BMLoop *l)
|
||||
*
|
||||
* Calculate the normal at this loop corner or fallback to the face normal on straight lines.
|
||||
*
|
||||
* \param l The loop to calculate the normal at
|
||||
* \param epsilon: Value to avoid numeric errors (1e-5f works well).
|
||||
* \param r_normal Resulting normal
|
||||
* \param l: The loop to calculate the normal at.
|
||||
* \param epsilon_sq: Value to avoid numeric errors (1e-5f works well).
|
||||
* \param r_normal: Resulting normal.
|
||||
*/
|
||||
float BM_loop_calc_face_normal_safe_ex(const BMLoop *l, const float epsilon_sq, float r_normal[3])
|
||||
{
|
||||
|
@ -313,7 +313,7 @@ typedef struct BoneFlipNameData {
|
||||
*
|
||||
* \param arm: Armature the bones belong to
|
||||
* \param bones_names: List of BoneConflict elems.
|
||||
* \param do_flip_numbers: if set, try to get rid of dot-numbers at end of bone names.
|
||||
* \param do_strip_numbers: if set, try to get rid of dot-numbers at end of bone names.
|
||||
*/
|
||||
void ED_armature_bones_flip_names(bArmature *arm, ListBase *bones_names, const bool do_strip_numbers)
|
||||
{
|
||||
|
@ -31,10 +31,10 @@
|
||||
*
|
||||
* Typical view-control usage:
|
||||
*
|
||||
* - acquire a view-control (#ED_view3d_control_acquire).
|
||||
* - acquire a view-control (#ED_view3d_cameracontrol_acquire).
|
||||
* - modify ``rv3d->ofs``, ``rv3d->viewquat``.
|
||||
* - update the view data (#ED_view3d_control_acquire) - within a loop which draws the viewport.
|
||||
* - finish and release the view-control (#ED_view3d_control_release),
|
||||
* - update the view data (#ED_view3d_cameracontrol_acquire) - within a loop which draws the viewport.
|
||||
* - finish and release the view-control (#ED_view3d_cameracontrol_release),
|
||||
* either keeping the current view or restoring the initial view.
|
||||
*
|
||||
* Notes:
|
||||
|
@ -720,7 +720,7 @@ static float screen_aligned(RegionView3D *rv3d, float mat[4][4])
|
||||
* \param start: Starting segment (based on \a nrings).
|
||||
* \param end: End segment.
|
||||
* \param nsides: Number of points in ring.
|
||||
* \param nrigns: Number of rings.
|
||||
* \param nrings: Number of rings.
|
||||
*/
|
||||
static void partial_doughnut(float radring, float radhole, int start, int end, int nsides, int nrings)
|
||||
{
|
||||
|
@ -59,6 +59,10 @@
|
||||
|
||||
#include "transform.h"
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** Internal Data Types
|
||||
* \{ */
|
||||
|
||||
enum eViewProj {
|
||||
VIEW_PROJ_NONE = -1,
|
||||
VIEW_PROJ_ORTHO = 0,
|
||||
@ -132,10 +136,8 @@ struct SnapObjectContext {
|
||||
|
||||
/** \} */
|
||||
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
||||
/** Common utilities
|
||||
/** Common Utilities
|
||||
* \{ */
|
||||
|
||||
|
||||
@ -256,9 +258,7 @@ static int dm_looptri_to_poly_index(DerivedMesh *dm, const MLoopTri *lt);
|
||||
|
||||
/** \} */
|
||||
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
||||
/** \name Ray Cast Funcs
|
||||
* \{ */
|
||||
|
||||
@ -785,7 +785,6 @@ static void raycast_obj_cb(SnapObjectContext *sctx, bool is_obedit, Object *ob,
|
||||
* Walks through all objects in the scene to find the `hit` on object surface.
|
||||
*
|
||||
* \param sctx: Snap context to store data.
|
||||
* \param snapdata: struct generated in `set_snapdata`.
|
||||
* \param snap_select : from enum eSnapSelect.
|
||||
* \param use_object_edit_cage : Uses the coordinates of BMesh(if any) to do the snapping.
|
||||
* \param obj_list: List with objects to snap (created in `create_object_list`).
|
||||
@ -842,9 +841,7 @@ static bool raycastObjects(
|
||||
|
||||
/** \} */
|
||||
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
||||
/** Snap Nearest utilities
|
||||
* \{ */
|
||||
|
||||
@ -1154,9 +1151,7 @@ static float dist_squared_to_projected_aabb_simple(
|
||||
|
||||
/** \} */
|
||||
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
||||
/** Walk DFS
|
||||
* \{ */
|
||||
|
||||
@ -1252,7 +1247,6 @@ static bool cb_nearest_walk_order(const BVHTreeAxisRange *UNUSED(bounds), char a
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
||||
/** \name Internal Object Snapping API
|
||||
* \{ */
|
||||
|
||||
@ -2076,9 +2070,7 @@ static bool snapObjectsRay(
|
||||
|
||||
/** \} */
|
||||
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
||||
/** \name Public Object Snapping API
|
||||
* \{ */
|
||||
|
||||
|
@ -181,9 +181,6 @@ void undo_editmode_push(
|
||||
}
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
|
||||
/* helper to remove clean other objects from undo stack */
|
||||
static void undo_clean_stack(bContext *C)
|
||||
{
|
||||
|
@ -57,7 +57,7 @@
|
||||
* \section dna_genfile Overview
|
||||
*
|
||||
* - please note: no builtin security to detect input of double structs
|
||||
* - if you want a struct not to be in DNA file: add two hash marks above it (#<enter>#<enter>)
|
||||
* - if you want a struct not to be in DNA file: add two hash marks above it `(#<enter>#<enter>)`.
|
||||
*
|
||||
* Structure DNA data is added to each blender file and to each executable, this to detect
|
||||
* in .blend files new variables in structs, changed array sizes, etc. It's also used for
|
||||
|
@ -505,7 +505,7 @@ static void wm_window_ghostwindow_add(wmWindowManager *wm, const char *title, wm
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize #wmWindows without ghostwin, open these and clear.
|
||||
* Initialize #wmWindow without ghostwin, open these and clear.
|
||||
*
|
||||
* window size is read from window, if 0 it uses prefsize
|
||||
* called in #WM_check, also inits stuff after file read.
|
||||
|
Loading…
Reference in New Issue
Block a user