blender
/
blender
134
424
Fork 606
Code Issues 6.4k Pull Requests 770 Projects 19 Wiki Activity

Merge branch 'master' into blender2.8

This commit is contained in:
Campbell Barton 2018-12-12 12:55:20 +11:00
parent 16fc62e15f e757c4a3be
commit 49490e5cfb
203 changed files with 1195 additions and 1194 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/blender/alembic/intern/abc_exporter.cc
View File

@ -140,8 +140,8 @@ static bool object_type_is_exportable(Scene *scene, Object *ob)
/**
* Returns whether this object should be exported into the Alembic file.
*
* \param settings export settings, used for options like 'selected only'.
* \param ob the object's base in question.
* \param settings: export settings, used for options like 'selected only'.
* \param ob: the object's base in question.
* \param is_duplicated: Normally false; true when the object is instanced
* into the scene by a dupli-object (e.g. part of a dupligroup).
* This ignores selection and layer visibility,

8
source/blender/alembic/intern/abc_util.cc
View File

@ -62,13 +62,13 @@ std::string get_id_name(const ID * const id)
}
/**
* @brief get_object_dag_path_name returns the name under which the object
* \brief get_object_dag_path_name returns the name under which the object
* will be exported in the Alembic file. It is of the form
* "[../grandparent/]parent/object" if dupli_parent is NULL, or
* "dupli_parent/[../grandparent/]parent/object" otherwise.
* @param ob
* @param dupli_parent
* @return
* \param ob:
* \param dupli_parent:
* \return
*/
std::string get_object_dag_path_name(const Object * const ob, Object *dupli_parent)
{

8
source/blender/alembic/intern/alembic_capi.cc
View File

@ -420,11 +420,11 @@ bool ABC_export(
/**
* Generates an AbcObjectReader for this Alembic object and its children.
*
* \param object The Alembic IObject to visit.
* \param readers The created AbcObjectReader * will be appended to this vector.
* \param settings Import settings, not used directly but passed to the
* \param object: The Alembic IObject to visit.
* \param readers: The created AbcObjectReader * will be appended to this vector.
* \param settings: Import settings, not used directly but passed to the
* AbcObjectReader subclass constructors.
* \param r_assign_as_parent Return parameter, contains a list of reader
* \param r_assign_as_parent: Return parameter, contains a list of reader
* pointers, whose parent pointer should still be set.
* This is filled when this call to visit_object() didn't create
* a reader that should be the parent.

2
source/blender/blenkernel/BKE_idcode.h
View File

@ -47,7 +47,7 @@ int BKE_idcode_to_index(const short idcode);
/**
* Return an ID code and steps the index forward 1.
*
* \param index start as 0.
* \param index: start as 0.
* \return the code, 0 when all codes have been returned.
*/
short BKE_idcode_iter_step(int *index);

2
source/blender/blenkernel/BKE_modifier.h
View File

@ -157,7 +157,7 @@ typedef struct ModifierTypeInfo {
/* Copy instance data for this modifier type. Should copy all user
* level settings to the target modifier.
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void (*copyData)(const struct ModifierData *md, struct ModifierData *target, const int flag);

4
source/blender/blenkernel/intern/action.c
View File

@ -127,7 +127,7 @@ void BKE_action_free(bAction *act)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_action_copy_data(Main *UNUSED(bmain), bAction *act_dst, const bAction *act_src, const int UNUSED(flag))
{
@ -534,7 +534,7 @@ const char *BKE_pose_ikparam_get_name(bPose *pose)
* Allocate a new pose on the heap, and copy the src pose and it's channels
* into the new pose. *dst is set to the newly allocated structure, and assumed to be NULL.
*
* \param dst Should be freed already, makes entire duplicate.
* \param dst: Should be freed already, makes entire duplicate.
*/
void BKE_pose_copy_data_ex(bPose **dst, const bPose *src, const int flag, const bool copy_constraints)
{

6
source/blender/blenkernel/intern/anim.c
View File

@ -168,9 +168,9 @@ bMotionPath *animviz_copy_motionpath(const bMotionPath *mpath_src)
* Setup motion paths for the given data.
* \note Only used when explicitly calculating paths on bones which may/may not be consider already
*
* \param scene Current scene (for frame ranges, etc.)
* \param ob Object to add paths for (must be provided)
* \param pchan Posechannel to add paths for (optional; if not provided, object-paths are assumed)
* \param scene: Current scene (for frame ranges, etc.)
* \param ob: Object to add paths for (must be provided)
* \param pchan: Posechannel to add paths for (optional; if not provided, object-paths are assumed)
*/
bMotionPath *animviz_verify_motionpaths(ReportList *reports, Scene *scene, Object *ob, bPoseChannel *pchan)
{

12
source/blender/blenkernel/intern/anim_sys.c
View File

@ -268,7 +268,7 @@ void BKE_animdata_free(ID *id, const bool do_id_user)
/**
* Make a copy of the given AnimData - to be used when copying datablocks.
* \param flag Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
* \param flag: Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
* \return The copied animdata.
*/
AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, const int flag)
@ -309,7 +309,7 @@ AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, const int flag)
}
/**
* \param flag Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
* \param flag: Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
* \return true is succesfully copied.
*/
bool BKE_animdata_copy_id(Main *bmain, ID *id_to, ID *id_from, const int flag)
@ -425,8 +425,8 @@ void BKE_animdata_merge_copy(
/**
* Helper heuristic for determining if a path is compatible with the basepath
*
* \param path Full RNA-path from some data (usually an F-Curve) to compare
* \param basepath Shorter path fragment to look for
* \param path: Full RNA-path from some data (usually an F-Curve) to compare
* \param basepath: Shorter path fragment to look for
* \return Whether there is a match
*/
static bool animpath_matches_basepath(const char path[], const char basepath[])
@ -598,9 +598,9 @@ void BKE_animdata_separate_by_basepath(
* such drivers by rerouting all paths through the active object instead so that
* they will get picked up by the dependency system.
*
* \param C Context pointer - for getting active data
* \param C: Context pointer - for getting active data
* \param[in,out] ptr RNA pointer for property's datablock. May be modified as result of path remapping.
* \param prop RNA definition of property to add for
* \param prop: RNA definition of property to add for
* \return MEM_alloc'd string representing the path to the property from the given #PointerRNA
*/
char *BKE_animdata_driver_path_hack(bContext *C, PointerRNA *ptr, PropertyRNA *prop, char *base_path)

36
source/blender/blenkernel/intern/appdir.c
View File

@ -184,10 +184,10 @@ static bool test_env_path(char *path, const char *envvar)
* Constructs in \a targetpath the name of a directory relative to a version-specific
* subdirectory in the parent directory of the Blender executable.
*
* \param targetpath String to return path
* \param folder_name Optional folder name within version-specific directory
* \param subfolder_name Optional subfolder name within folder_name
* \param ver To construct name of version-specific directory within bprogdir
* \param targetpath: String to return path
* \param folder_name: Optional folder name within version-specific directory
* \param subfolder_name: Optional subfolder name within folder_name
* \param ver: To construct name of version-specific directory within bprogdir
* \return true if such a directory exists.
*/
static bool get_path_local(
@ -275,10 +275,10 @@ static bool get_path_environment(
* Returns the path of a folder within the user-files area.
*
*
* \param targetpath String to return path
* \param folder_name default name of folder within user area
* \param subfolder_name optional name of subfolder within folder
* \param ver Blender version, used to construct a subdirectory name
* \param targetpath: String to return path
* \param folder_name: default name of folder within user area
* \param subfolder_name: optional name of subfolder within folder
* \param ver: Blender version, used to construct a subdirectory name
* \return true if it was able to construct such a path.
*/
static bool get_path_user(
@ -316,10 +316,10 @@ static bool get_path_user(
/**
* Returns the path of a folder within the Blender installation directory.
*
* \param targetpath String to return path
* \param folder_name default name of folder within installation area
* \param subfolder_name optional name of subfolder within folder
* \param ver Blender version, used to construct a subdirectory name
* \param targetpath: String to return path
* \param folder_name: default name of folder within installation area
* \param subfolder_name: optional name of subfolder within folder
* \param ver: Blender version, used to construct a subdirectory name
* \return true if it was able to construct such a path.
*/
static bool get_path_system(
@ -544,9 +544,9 @@ const char *BKE_appdir_folder_id_version(const int folder_id, const int ver, con
* the name to its 8.3 version to prevent problems with
* spaces and stuff. Final result is returned in fullname.
*
* \param fullname The full path and full name of the executable
* \param fullname: The full path and full name of the executable
* (must be FILE_MAX minimum)
* \param name The name of the executable (usually argv[0]) to be checked
* \param name: The name of the executable (usually argv[0]) to be checked
*/
static void where_am_i(char *fullname, const size_t maxlen, const char *name)
{
@ -772,10 +772,10 @@ void BKE_appdir_app_templates(ListBase *templates)
*
* Also make sure the temp dir has a trailing slash
*
* \param fullname The full path to the temporary temp directory
* \param basename The full path to the persistent temp directory (may be NULL)
* \param maxlen The size of the fullname buffer
* \param userdir Directory specified in user preferences
* \param fullname: The full path to the temporary temp directory
* \param basename: The full path to the persistent temp directory (may be NULL)
* \param maxlen: The size of the fullname buffer
* \param userdir: Directory specified in user preferences
*/
static void where_is_temp(char *fullname, char *basename, const size_t maxlen, char *userdir)
{

4
source/blender/blenkernel/intern/armature.c
View File

@ -176,7 +176,7 @@ static void copy_bonechildren(
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_armature_copy_data(Main *UNUSED(bmain), bArmature *arm_dst, const bArmature *arm_src, const int flag)
{
@ -2182,7 +2182,7 @@ void BKE_pchan_rebuild_bbone_handles(bPose *pose, bPoseChannel *pchan)
*
* \note pose->flag is set for it.
*
* \param bmain May be NULL, only used to tag depsgraph as being dirty...
* \param bmain: May be NULL, only used to tag depsgraph as being dirty...
*/
void BKE_pose_rebuild(Main *bmain, Object *ob, bArmature *arm, const bool do_id_user)
{

2
source/blender/blenkernel/intern/autoexec.c
View File

@ -43,7 +43,7 @@
#include "BKE_autoexec.h" /* own include */
/**
* \param path The path to check against.
* \param path: The path to check against.
* \return Success
*/
bool BKE_autoexec_match(const char *path)

2
source/blender/blenkernel/intern/brush.c
View File

@ -566,7 +566,7 @@ struct Brush *BKE_brush_first_search(struct Main *bmain, const eObjectMode ob_mo
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_brush_copy_data(Main *UNUSED(bmain), Brush *brush_dst, const Brush *brush_src, const int flag)
{

13
source/blender/blenkernel/intern/bvhutils.c
View File

@ -531,9 +531,9 @@ BVHTree *bvhtree_from_editmesh_verts(
/**
* Builds a bvh tree where nodes are the given vertices (note: does not copy given mverts!).
* \param vert_allocated if true, vert freeing will be done when freeing data.
* \param verts_mask if not null, true elements give which vert to add to BVH tree.
* \param verts_num_active if >= 0, number of active verts to add to BVH tree (else will be computed from mask).
* \param vert_allocated: if true, vert freeing will be done when freeing data.
* \param verts_mask: if not null, true elements give which vert to add to BVH tree.
* \param verts_num_active: if >= 0, number of active verts to add to BVH tree (else will be computed from mask).
*/
BVHTree *bvhtree_from_mesh_verts_ex(
BVHTreeFromMesh *data, const MVert *vert, const int verts_num, const bool vert_allocated,
@ -712,9 +712,10 @@ BVHTree *bvhtree_from_editmesh_edges(
/**
* Builds a bvh tree where nodes are the given edges .
* \param vert/edge_allocated if true, elem freeing will be done when freeing data.
* \param edges_mask if not null, true elements give which vert to add to BVH tree.
* \param edges_num_active if >= 0, number of active edges to add to BVH tree (else will be computed from mask).
* \param vert, vert_allocated: if true, elem freeing will be done when freeing data.
* \param edge, edge_allocated: if true, elem freeing will be done when freeing data.
* \param edges_mask: if not null, true elements give which vert to add to BVH tree.
* \param edges_num_active: if >= 0, number of active edges to add to BVH tree (else will be computed from mask).
*/
BVHTree *bvhtree_from_mesh_edges_ex(
BVHTreeFromMesh *data,

2
source/blender/blenkernel/intern/cachefile.c
View File

@ -114,7 +114,7 @@ void BKE_cachefile_free(CacheFile *cache_file)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_cachefile_copy_data(
Main *UNUSED(bmain), CacheFile *cache_file_dst, const CacheFile *UNUSED(cache_file_src), const int UNUSED(flag))

2
source/blender/blenkernel/intern/camera.c
View File

@ -103,7 +103,7 @@ void *BKE_camera_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_camera_copy_data(Main *UNUSED(bmain), Camera *cam_dst, const Camera *cam_src, const int UNUSED(flag))
{

4
source/blender/blenkernel/intern/collection.c
View File

@ -187,7 +187,7 @@ bool BKE_collection_delete(Main *bmain, Collection *collection, bool hierarchy)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_collection_copy_data(
Main *bmain, Collection *collection_dst, const Collection *collection_src, const int flag)
@ -692,7 +692,7 @@ static void collection_missing_parents_remove(Collection *collection)
*
* \note caller must ensure BKE_main_collection_sync_remap() is called afterwards!
*
* \param collection may be \a NULL, in which case whole \a bmain database of collections is checked.
* \param collection: may be \a NULL, in which case whole \a bmain database of collections is checked.
*/
void BKE_collections_child_remove_nulls(Main *bmain, Collection *collection)
{

4
source/blender/blenkernel/intern/colortools.c
View File

@ -960,8 +960,8 @@ static void curvemapping_evaluateRGBF_filmlike(const CurveMapping *cumap, float
*
* Use in conjunction with #curvemapping_set_black_white_ex
*
* \param black Use instead of cumap->black
* \param bwmul Use instead of cumap->bwmul
* \param black: Use instead of cumap->black
* \param bwmul: Use instead of cumap->bwmul
*/
void curvemapping_evaluate_premulRGBF_ex(
const CurveMapping *cumap, float vecout[3], const float vecin[3],

8
source/blender/blenkernel/intern/context.c
View File

@ -471,10 +471,10 @@ static void data_dir_add(ListBase *lb, const char *member, const bool use_all)
}
/**
* \param C Context
* \param use_store Use 'C->wm.store'
* \param use_rna Use Include the properties from 'RNA_Context'
* \param use_all Don't skip values (currently only "scene")
* \param C: Context
* \param use_store: Use 'C->wm.store'
* \param use_rna: Use Include the properties from 'RNA_Context'
* \param use_all: Don't skip values (currently only "scene")
*/
ListBase CTX_data_dir_get_ex(const bContext *C, const bool use_store, const bool use_rna, const bool use_all)
{

8
source/blender/blenkernel/intern/curve.c
View File

@ -197,7 +197,7 @@ Curve *BKE_curve_add(Main *bmain, const char *name, int type)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_curve_copy_data(Main *bmain, Curve *cu_dst, const Curve *cu_src, const int flag)
{
@ -1366,9 +1366,9 @@ void BKE_nurb_makeFaces(const Nurb *nu, float *coord_array, int rowstride, int r
}
/**
* \param coord_array Has to be 3 * 4 * pntsu * resolu in size and zero-ed
* \param tilt_array set when non-NULL
* \param radius_array set when non-NULL
* \param coord_array: Has to be 3 * 4 * pntsu * resolu in size and zero-ed
* \param tilt_array: set when non-NULL
* \param radius_array: set when non-NULL
*/
void BKE_nurb_makeCurve(
const Nurb *nu, float *coord_array, float *tilt_array, float *radius_array, float *weight_array,

12
source/blender/blenkernel/intern/customdata.c
View File

@ -2404,7 +2404,7 @@ void CustomData_interp(const CustomData *source, CustomData *dest,
* This only applies to item types that may store several sub-item data (e.g. corner data [UVs, VCol, ...] of
* tessellated faces).
*
* \param corner_indices A mapping 'new_index -> old_index' of sub-item data.
* \param corner_indices: A mapping 'new_index -> old_index' of sub-item data.
*/
void CustomData_swap_corners(struct CustomData *data, int index, const int *corner_indices)
{
@ -3262,7 +3262,7 @@ void CustomData_bmesh_set_default(CustomData *data, void **block)
}
/**
* \param use_default_init initializes data which can't be copied,
* \param use_default_init: initializes data which can't be copied,
* typically you'll want to use this if the BM_xxx create function
* is called with BM_CREATE_SKIP_CD flag
*/
@ -3374,11 +3374,11 @@ void CustomData_file_write_info(int type, const char **r_struct_name, int *r_str
/**
* Prepare given custom data for file writing.
*
* \param data the customdata to tweak for .blend file writing (modified in place).
* \param r_write_layers contains a reduced set of layers to be written to file, use it with writestruct_at_address()
* \param data: the customdata to tweak for .blend file writing (modified in place).
* \param r_write_layers: contains a reduced set of layers to be written to file, use it with writestruct_at_address()
* (caller must free it if != \a write_layers_buff).
* \param write_layers_buff an optional buffer for r_write_layers (to avoid allocating it).
* \param write_layers_size the size of pre-allocated \a write_layer_buff.
* \param write_layers_buff: an optional buffer for r_write_layers (to avoid allocating it).
* \param write_layers_size: the size of pre-allocated \a write_layer_buff.
*
* \warning After this func has ran, given custom data is no more valid from Blender PoV (its totlayer is invalid).
* This func shall always be called with localized data (as it is in write_meshes()).

4
source/blender/blenkernel/intern/displist.c
View File

@ -456,9 +456,9 @@ static void curve_to_displist(Curve *cu, ListBase *nubase, ListBase *dispbase,
}
/**
* \param normal_proj Optional normal thats used to project the scanfill verts into 2d coords.
* \param normal_proj: Optional normal thats used to project the scanfill verts into 2d coords.
* Pass this along if known since it saves time calculating the normal.
* \param flipnormal Flip the normal (same as passing \a normal_proj negated)
* \param flipnormal: Flip the normal (same as passing \a normal_proj negated)
*/
void BKE_displist_fill(ListBase *dispbase, ListBase *to, const float normal_proj[3], const bool flipnormal)
{

28
source/blender/blenkernel/intern/gpencil.c
View File

@ -447,8 +447,8 @@ bGPdata *BKE_gpencil_data_addnew(Main *bmain, const char name[])
/**
* Populate stroke with point data from data buffers
*
* \param array Flat array of point data values. Each entry has GP_PRIM_DATABUF_SIZE values
* \param mat 4x4 transform matrix to transform points into the right coordinate space
* \param array: Flat array of point data values. Each entry has GP_PRIM_DATABUF_SIZE values
* \param mat: 4x4 transform matrix to transform points into the right coordinate space
*/
void BKE_gpencil_stroke_add_points(bGPDstroke *gps, const float *array, const int totpoints, const float mat[4][4])
{
@ -621,7 +621,7 @@ bGPDlayer *BKE_gpencil_layer_duplicate(const bGPDlayer *gpl_src)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_gpencil_copy_data(bGPdata *gpd_dst, const bGPdata *gpd_src, const int UNUSED(flag))
{
@ -1233,9 +1233,9 @@ void BKE_gpencil_dvert_ensure(bGPDstroke *gps)
/**
* Apply smooth to stroke point
* \param gps Stroke to smooth
* \param i Point index
* \param inf Amount of smoothing to apply
* \param gps: Stroke to smooth
* \param i: Point index
* \param inf: Amount of smoothing to apply
*/
bool BKE_gpencil_smooth_stroke(bGPDstroke *gps, int i, float inf)
{
@ -1412,9 +1412,9 @@ bool BKE_gpencil_smooth_stroke_uv(bGPDstroke *gps, int point_index, float influe
* Get range of selected frames in layer.
* Always the active frame is considered as selected, so if no more selected the range
* will be equal to the current active frame.
* \param gpl Layer
* \param r_initframe Number of first selected frame
* \param r_endframe Number of last selected frame
* \param gpl: Layer
* \param r_initframe: Number of first selected frame
* \param r_endframe: Number of last selected frame
*/
void BKE_gpencil_get_range_selected(bGPDlayer *gpl, int *r_initframe, int *r_endframe)
{
@ -1435,11 +1435,11 @@ void BKE_gpencil_get_range_selected(bGPDlayer *gpl, int *r_initframe, int *r_end
/**
* Get Falloff factor base on frame range
* \param gpf Frame
* \param actnum Number of active frame in layer
* \param f_init Number of first selected frame
* \param f_end Number of last selected frame
* \param cur_falloff Curve with falloff factors
* \param gpf: Frame
* \param actnum: Number of active frame in layer
* \param f_init: Number of first selected frame
* \param f_end: Number of last selected frame
* \param cur_falloff: Curve with falloff factors
*/
float BKE_gpencil_multiframe_falloff_calc(bGPDframe *gpf, int actnum, int f_init, int f_end, CurveMapping *cur_falloff)
{

4
source/blender/blenkernel/intern/idcode.c
View File

@ -165,7 +165,7 @@ const char *BKE_idcode_to_name(short idcode)
/**
* Convert a name into an idcode (ie. ID_SCE)
*
* \param name The name to convert.
* \param name: The name to convert.
* \return The code for the name, or 0 if invalid.
*/
short BKE_idcode_from_name(const char *name)
@ -348,7 +348,7 @@ const char *BKE_idcode_to_translation_context(short idcode)
/**
* Return an ID code and steps the index forward 1.
*
* \param index start as 0.
* \param index: start as 0.
* \return the code, 0 when all codes have been returned.
*/
short BKE_idcode_iter_step(int *index)

8
source/blender/blenkernel/intern/idprop.c
View File

@ -330,9 +330,9 @@ static IDProperty *IDP_CopyArray(const IDProperty *prop, const int flag)
/**
*
* \param st The string to assign.
* \param name The property name.
* \param maxlen The size of the new string (including the \0 terminator).
* \param st: The string to assign.
* \param name: The property name.
* \param maxlen: The size of the new string (including the \0 terminator).
* \return The new string property.
*/
IDProperty *IDP_NewString(const char *st, const char *name, int maxlen)
@ -837,7 +837,7 @@ IDProperty *IDP_GetProperties(ID *id, const bool create_if_needed)
}
/**
* \param is_strict When false treat missing items as a match */
* \param is_strict: When false treat missing items as a match */
bool IDP_EqualsProperties_ex(IDProperty *prop1, IDProperty *prop2, const bool is_strict)
{
if (prop1 == NULL && prop2 == NULL)

2
source/blender/blenkernel/intern/image.c
View File

@ -387,7 +387,7 @@ static void copy_image_packedfiles(ListBase *lb_dst, const ListBase *lb_src)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_image_copy_data(Main *UNUSED(bmain), Image *ima_dst, const Image *ima_src, const int flag)
{

20
source/blender/blenkernel/intern/key.c
View File

@ -166,7 +166,7 @@ Key *BKE_key_add(Main *bmain, ID *id) /* common function */
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_key_copy_data(Main *UNUSED(bmain), Key *key_dst, const Key *key_src, const int UNUSED(flag))
{
@ -1481,9 +1481,9 @@ KeyBlock *BKE_keyblock_add(Key *key, const char *name)
* \note sorting is a problematic side effect in some cases,
* better only do this explicitly by having its own function,
*
* \param key The key datablock to add to.
* \param name Optional name for the new keyblock.
* \param do_force always use ctime even for relative keys.
* \param key: The key datablock to add to.
* \param name: Optional name for the new keyblock.
* \param do_force: always use ctime even for relative keys.
*/
KeyBlock *BKE_keyblock_add_ctime(Key *key, const char *name, const bool do_force)
{
@ -1807,11 +1807,11 @@ void BKE_keyblock_convert_to_mesh(KeyBlock *kb, Mesh *me)
/**
* Computes normals (vertices, polygons and/or loops ones) of given mesh for given shape key.
*
* \param kb the KeyBlock to use to compute normals.
* \param mesh the Mesh to apply keyblock to.
* \param r_vertnors if non-NULL, an array of vectors, same length as number of vertices.
* \param r_polynors if non-NULL, an array of vectors, same length as number of polygons.
* \param r_loopnors if non-NULL, an array of vectors, same length as number of loops.
* \param kb: the KeyBlock to use to compute normals.
* \param mesh: the Mesh to apply keyblock to.
* \param r_vertnors: if non-NULL, an array of vectors, same length as number of vertices.
* \param r_polynors: if non-NULL, an array of vectors, same length as number of polygons.
* \param r_loopnors: if non-NULL, an array of vectors, same length as number of loops.
*/
void BKE_keyblock_mesh_calc_normals(
struct KeyBlock *kb, struct Mesh *mesh,
@ -2053,7 +2053,7 @@ void BKE_keyblock_update_from_offset(Object *ob, KeyBlock *kb, float (*ofs)[3])
* the object's active shape index, the 'frame' value in case of absolute keys, etc.
* Note indices are expected in real values (not 'fake' shapenr +1 ones).
*
* \param org_index if < 0, current object's active shape will be used as skey to move.
* \param org_index: if < 0, current object's active shape will be used as skey to move.
* \return true if something was done, else false.
*/
bool BKE_keyblock_move(Object *ob, int org_index, int new_index)

2
source/blender/blenkernel/intern/lamp.c
View File

@ -111,7 +111,7 @@ Lamp *BKE_lamp_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_lamp_copy_data(Main *bmain, Lamp *la_dst, const Lamp *la_src, const int flag)
{

2
source/blender/blenkernel/intern/lattice.c
View File

@ -280,7 +280,7 @@ Lattice *BKE_lattice_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_lattice_copy_data(Main *bmain, Lattice *lt_dst, const Lattice *lt_src, const int flag)
{

2
source/blender/blenkernel/intern/layer.c
View File

@ -384,7 +384,7 @@ static void layer_collections_copy_data(
/**
* Only copy internal data of ViewLayer from source to already allocated/initialized destination.
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_view_layer_copy_data(
Scene *scene_dst, const Scene *UNUSED(scene_src),

28
source/blender/blenkernel/intern/library.c
View File

@ -373,7 +373,7 @@ void BKE_id_make_local_generic(Main *bmain, ID *id, const bool id_in_mainlist, c
*
* \note Always set ID->newid pointer in case it gets duplicated...
*
* \param lib_local Special flag used when making a whole library's content local, it needs specific handling.
* \param lib_local: Special flag used when making a whole library's content local, it needs specific handling.
*
* \return true if the block can be made local.
*/
@ -525,11 +525,11 @@ static int id_copy_libmanagement_cb(void *user_data, ID *UNUSED(id_self), ID **i
*
* \note Usercount of new copy is always set to 1.
*
* \param bmain Main database, may be NULL only if LIB_ID_CREATE_NO_MAIN is specified.
* \param id Source datablock.
* \param r_newid Pointer to new (copied) ID pointer.
* \param flag Set of copy options, see DNA_ID.h enum for details (leave to zero for default, full copy).
* \param test If set, do not do any copy, just test whether copy is supported.
* \param bmain: Main database, may be NULL only if LIB_ID_CREATE_NO_MAIN is specified.
* \param id: Source datablock.
* \param r_newid: Pointer to new (copied) ID pointer.
* \param flag: Set of copy options, see DNA_ID.h enum for details (leave to zero for default, full copy).
* \param test: If set, do not do any copy, just test whether copy is supported.
* \return False when copying that ID type is not supported, true otherwise.
*/
/* XXX TODO remove test thing, *all* IDs should be copyable that way! */
@ -1240,7 +1240,7 @@ void BKE_libblock_init_empty(ID *id)
/** Generic helper to create a new empty datablock of given type in given \a bmain database.
*
* \param name can be NULL, in which case we get default name for this ID type. */
* \param name: can be NULL, in which case we get default name for this ID type. */
void *BKE_id_new(Main *bmain, const short type, const char *name)
{
BLI_assert(bmain != NULL);
@ -1257,7 +1257,7 @@ void *BKE_id_new(Main *bmain, const short type, const char *name)
/** Generic helper to create a new temporary empty datablock of given type, *outside* of any Main database.
*
* \param name can be NULL, in which case we get default name for this ID type. */
* \param name: can be NULL, in which case we get default name for this ID type. */
void *BKE_id_new_nomain(const short type, const char *name)
{
if (name == NULL) {
@ -1714,10 +1714,10 @@ static void library_make_local_copying_check(ID *id, GSet *loop_tags, MainIDRela
/** Make linked datablocks local.
*
* \param bmain Almost certainly global main.
* \param lib If not NULL, only make local datablocks from this library.
* \param untagged_only If true, only make local datablocks not tagged with LIB_TAG_PRE_EXISTING.
* \param set_fake If true, set fake user on all localized datablocks (except group and objects ones).
* \param bmain: Almost certainly global main.
* \param lib: If not NULL, only make local datablocks from this library.
* \param untagged_only: If true, only make local datablocks not tagged with LIB_TAG_PRE_EXISTING.
* \param set_fake: If true, set fake user on all localized datablocks (except group and objects ones).
*/
/* Note: Old (2.77) version was simply making (tagging) datablocks as local, without actually making any check whether
* they were also indirectly used or not...
@ -2138,7 +2138,7 @@ void BKE_libblock_rename(Main *bmain, ID *id, const char *name)
*
* \note Result is unique to a given ID type in a given Main database.
*
* \param name An allocated string of minimal length MAX_ID_FULL_NAME, will be filled with generated string.
* \param name: An allocated string of minimal length MAX_ID_FULL_NAME, will be filled with generated string.
*/
void BKE_id_full_name_get(char name[MAX_ID_FULL_NAME], const ID *id)
{
@ -2162,7 +2162,7 @@ void BKE_id_full_name_get(char name[MAX_ID_FULL_NAME], const ID *id)
*
* \note Result is unique to a given ID type in a given Main database.
*
* \param name An allocated string of minimal length MAX_ID_FULL_NAME_UI, will be filled with generated string.
* \param name: An allocated string of minimal length MAX_ID_FULL_NAME_UI, will be filled with generated string.
*/
void BKE_id_full_name_ui_prefix_get(char name[MAX_ID_FULL_NAME_UI], const ID *id)
{

6
source/blender/blenkernel/intern/library_query.c
View File

@ -1180,8 +1180,8 @@ static int foreach_libblock_id_users_callback(void *user_data, ID *UNUSED(self_i
* \note This only checks for pointer references of an ID, shallow usages (like e.g. by RNA paths, as done
* for FCurves) are not detected at all.
*
* \param id_user the ID which is supposed to use (reference) \a id_used.
* \param id_used the ID which is supposed to be used (referenced) by \a id_user.
* \param id_user: the ID which is supposed to use (reference) \a id_used.
* \param id_used: the ID which is supposed to be used (referenced) by \a id_user.
* \return the number of direct usages/references of \a id_used by \a id_user.
*/
int BKE_library_ID_use_ID(ID *id_user, ID *id_used)
@ -1317,7 +1317,7 @@ static int foreach_libblock_used_linked_data_tag_clear_cb(
* including complex cases like 'linked archipelagoes', i.e. linked datablocks that use each other in loops,
* which prevents their deletion by 'basic' usage checks...
*
* \param do_init_tag if \a true, all linked data are checked, if \a false, only linked datablocks already tagged with
* \param do_init_tag: if \a true, all linked data are checked, if \a false, only linked datablocks already tagged with
* LIB_TAG_DOIT are checked.
*/
void BKE_library_unused_linked_data_set_tag(Main *bmain, const bool do_init_tag)

2
source/blender/blenkernel/intern/lightprobe.c
View File

@ -75,7 +75,7 @@ void *BKE_lightprobe_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_lightprobe_copy_data(
Main *UNUSED(bmain), LightProbe *UNUSED(probe_dst), const LightProbe *UNUSED(probe_src), const int UNUSED(flag))

2
source/blender/blenkernel/intern/linestyle.c
View File

@ -160,7 +160,7 @@ void BKE_linestyle_free(FreestyleLineStyle *linestyle)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_linestyle_copy_data(
struct Main *bmain, FreestyleLineStyle *linestyle_dst, const FreestyleLineStyle *linestyle_src, const int flag)

8
source/blender/blenkernel/intern/main.c
View File

@ -215,8 +215,8 @@ void BKE_main_relations_free(Main *bmain)
/**
* Generates a raw .blend file thumbnail data from given image.
*
* \param bmain If not NULL, also store generated data in this Main.
* \param img ImBuf image to generate thumbnail data from.
* \param bmain: If not NULL, also store generated data in this Main.
* \param img: ImBuf image to generate thumbnail data from.
* \return The generated .blend file raw thumbnail data.
*/
BlendThumbnail *BKE_main_thumbnail_from_imbuf(Main *bmain, ImBuf *img)
@ -246,8 +246,8 @@ BlendThumbnail *BKE_main_thumbnail_from_imbuf(Main *bmain, ImBuf *img)
/**
* Generates an image from raw .blend file thumbnail \a data.
*
* \param bmain Use this bmain->blen_thumb data if given \a data is NULL.
* \param data Raw .blend file thumbnail data.
* \param bmain: Use this bmain->blen_thumb data if given \a data is NULL.
* \param data: Raw .blend file thumbnail data.
* \return An ImBuf from given data, or NULL if invalid.
*/
ImBuf *BKE_main_thumbnail_to_imbuf(Main *bmain, BlendThumbnail *data)

2
source/blender/blenkernel/intern/mask.c
View File

@ -851,7 +851,7 @@ Mask *BKE_mask_copy_nolib(Mask *mask)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_mask_copy_data(Main *UNUSED(bmain), Mask *mask_dst, const Mask *mask_src, const int UNUSED(flag))
{

2
source/blender/blenkernel/intern/material.c
View File

@ -185,7 +185,7 @@ Material *BKE_material_add_gpencil(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_material_copy_data(Main *bmain, Material *ma_dst, const Material *ma_src, const int flag)
{

2
source/blender/blenkernel/intern/mball.c
View File

@ -110,7 +110,7 @@ MetaBall *BKE_mball_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_mball_copy_data(Main *UNUSED(bmain), MetaBall *mb_dst, const MetaBall *mb_src, const int UNUSED(flag))
{

4
source/blender/blenkernel/intern/mesh.c
View File

@ -529,7 +529,7 @@ Mesh *BKE_mesh_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_mesh_copy_data(Main *bmain, Mesh *me_dst, const Mesh *me_src, const int flag)
{
@ -1598,7 +1598,7 @@ void BKE_mesh_apply_vert_normals(Mesh *mesh, short (*vertNormals)[3])
/**
* Compute 'split' (aka loop, or per face corner's) normals.
*
* \param r_lnors_spacearr Allows to get computed loop normal space array. That data, among other things,
* \param r_lnors_spacearr: Allows to get computed loop normal space array. That data, among other things,
* contains 'smooth fan' info, useful e.g. to split geometry along sharp edges...
*/
void BKE_mesh_calc_normals_split_ex(Mesh *mesh, MLoopNorSpaceArray *r_lnors_spacearr)

16
source/blender/blenkernel/intern/mesh_evaluate.c
View File

@ -2507,7 +2507,7 @@ void BKE_mesh_loops_to_mface_corners(
/**
* Convert all CD layers from loop/poly to tessface data.
*
* \param loopindices is an array of an int[4] per tessface, mapping tessface's verts to loops indices.
* \param loopindices: is an array of an int[4] per tessface, mapping tessface's verts to loops indices.
*
* \note when mface is not NULL, mface[face_index].v4 is used to test quads, else, loopindices[face_index][3] is used.
*/
@ -3334,9 +3334,9 @@ void BKE_mesh_mdisp_flip(MDisps *md, const bool use_loop_mdisp_flip)
* Flip (invert winding of) the given \a mpoly, i.e. reverse order of its loops
* (keeping the same vertex as 'start point').
*
* \param mpoly the polygon to flip.
* \param mloop the full loops array.
* \param ldata the loops custom data.
* \param mpoly: the polygon to flip.
* \param mloop: the full loops array.
* \param ldata: the loops custom data.
*/
void BKE_mesh_polygon_flip_ex(
MPoly *mpoly, MLoop *mloop, CustomData *ldata,
@ -3601,11 +3601,11 @@ void BKE_mesh_flush_select_from_verts(Mesh *me)
* (\a vert_cos_src, \a vert_cos_dst),
* and applies the difference to \a vert_cos_new relative to \a vert_cos_org.
*
* \param vert_cos_src reference deform source.
* \param vert_cos_dst reference deform destination.
* \param vert_cos_src: reference deform source.
* \param vert_cos_dst: reference deform destination.
*
* \param vert_cos_org reference for the output location.
* \param vert_cos_new resulting coords.
* \param vert_cos_org: reference for the output location.
* \param vert_cos_new: resulting coords.
*/
void BKE_mesh_calc_relative_deform(
const MPoly *mpoly, const int totpoly,

8
source/blender/blenkernel/intern/mesh_mapping.c
View File

@ -507,9 +507,9 @@ void BKE_mesh_edge_poly_map_create(
*
* This has the advantage that it can operate on any data-types.
*
* \param totsource The total number of elements the that \a final_origindex points to.
* \param totfinal The size of \a final_origindex
* \param final_origindex The size of the final array.
* \param totsource: The total number of elements the that \a final_origindex points to.
* \param totfinal: The size of \a final_origindex
* \param final_origindex: The size of the final array.
*
* \note ``totsource`` could be ``totpoly``,
* ``totfinal`` could be ``tottessface`` and ``final_origindex`` its ORIGINDEX customdata.
@ -789,7 +789,7 @@ static bool poly_is_island_boundary_smooth_cb(
/**
* Calculate smooth groups from sharp edges.
*
* \param r_totgroup The total number of groups, 1 or more.
* \param r_totgroup: The total number of groups, 1 or more.
* \return Polygon aligned array of group index values (bitflags if use_bitflags is true), starting at 1
* (0 being used as 'invalid' flag).
* Note it's callers's responsibility to MEM_freeN returned array.

6
source/blender/blenkernel/intern/mesh_merge.c
View File

@ -219,15 +219,15 @@ static bool poly_gset_compare_fn(const void *k1, const void *k2)
*
* This frees the given mesh and returns a new mesh.
*
* \param vtargetmap The table that maps vertices to target vertices. a value of -1
* \param vtargetmap: The table that maps vertices to target vertices. a value of -1
* indicates a vertex is a target, and is to be kept.
* This array is aligned with 'mesh->totvert'
* \warning \a vtargetmap must **not** contain any chained mapping (v1 -> v2 -> v3 etc.), this is not supported
* and will likely generate corrupted geometry.
*
* \param tot_vtargetmap The number of non '-1' values in vtargetmap. (not the size)
* \param tot_vtargetmap: The number of non '-1' values in vtargetmap. (not the size)
*
* \param merge_mode enum with two modes.
* \param merge_mode: enum with two modes.
* - #MESH_MERGE_VERTS_DUMP_IF_MAPPED
* When called by the Mirror Modifier,
* In this mode it skips any faces that have all vertices merged (to avoid creating pairs

6
source/blender/blenkernel/intern/mesh_validate.c
View File

@ -1363,8 +1363,8 @@ void BKE_mesh_calc_edges_legacy(Mesh *me, const bool use_old)
/**
* Calculate edges from polygons
*
* \param mesh The mesh to add edges into
* \param update When true create new edges co-exist
* \param mesh: The mesh to add edges into
* \param update: When true create new edges co-exist
*/
void BKE_mesh_calc_edges(Mesh *mesh, bool update, const bool select)
{
@ -1473,7 +1473,7 @@ void BKE_mesh_calc_edges_loose(Mesh *mesh)
/**
* Calculate/create edges from tessface data
*
* \param mesh The mesh to add edges into
* \param mesh: The mesh to add edges into
*/
void BKE_mesh_calc_edges_tessface(Mesh *mesh)

2
source/blender/blenkernel/intern/modifier.c
View File

@ -471,7 +471,7 @@ bool modifiers_isParticleEnabled(Object *ob)
/**
* Check whether is enabled.
*
* \param scene Current scene, may be NULL, in which case isDisabled callback of the modifier is never called.
* \param scene: Current scene, may be NULL, in which case isDisabled callback of the modifier is never called.
*/
bool modifier_isEnabled(const struct Scene *scene, ModifierData *md, int required_mode)
{

2
source/blender/blenkernel/intern/movieclip.c
View File

@ -1514,7 +1514,7 @@ void BKE_movieclip_free(MovieClip *clip)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_movieclip_copy_data(Main *UNUSED(bmain), MovieClip *clip_dst, const MovieClip *clip_src, const int flag)
{

8
source/blender/blenkernel/intern/nla.c
View File

@ -162,8 +162,8 @@ void BKE_nla_tracks_free(ListBase *tracks, bool do_id_user)
/**
* Copy NLA strip
*
* \param use_same_action When true, the existing action is used (instead of being duplicated)
* \param flag Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
* \param use_same_action: When true, the existing action is used (instead of being duplicated)
* \param flag: Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
*/
NlaStrip *BKE_nlastrip_copy(Main *bmain, NlaStrip *strip, const bool use_same_action, const int flag)
{
@ -212,7 +212,7 @@ NlaStrip *BKE_nlastrip_copy(Main *bmain, NlaStrip *strip, const bool use_same_ac
/**
* Copy a single NLA Track.
* \param flag Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
* \param flag: Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
*/
NlaTrack *BKE_nlatrack_copy(Main *bmain, NlaTrack *nlt, const bool use_same_actions, const int flag)
{
@ -241,7 +241,7 @@ NlaTrack *BKE_nlatrack_copy(Main *bmain, NlaTrack *nlt, const bool use_same_acti
/**
* Copy all NLA data.
* \param flag Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
* \param flag: Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
*/
void BKE_nla_tracks_copy(Main *bmain, ListBase *dst, ListBase *src, const int flag)
{

4
source/blender/blenkernel/intern/node.c
View File

@ -850,7 +850,7 @@ bool nodeIsChildOf(const bNode *parent, const bNode *child)
* Iterate over a chain of nodes, starting with \a node_start, executing
* \a callback for each node (which can return false to end iterator).
*
* \param reversed for backwards iteration
* \param reversed: for backwards iteration
* \note Recursive
*/
void nodeChainIter(
@ -1302,7 +1302,7 @@ bNodeTree *ntreeAddTree(Main *bmain, const char *name, const char *idname)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_node_tree_copy_data(Main *UNUSED(bmain), bNodeTree *ntree_dst, const bNodeTree *ntree_src, const int flag)
{

20
source/blender/blenkernel/intern/object.c
View File

@ -937,7 +937,7 @@ Object *BKE_object_add(
/**
* Add a new object, using another one as a reference
*
* \param ob_src object to use to determine the collections of the new object.
* \param ob_src: object to use to determine the collections of the new object.
*/
Object *BKE_object_add_from(
Main *bmain, Scene *scene, ViewLayer *view_layer,
@ -959,9 +959,9 @@ Object *BKE_object_add_from(
* Add a new object, but assign the given datablock as the ob->data
* for the newly created object.
*
* \param data The datablock to assign as ob->data for the new object.
* \param data: The datablock to assign as ob->data for the new object.
* This is assumed to be of the correct type.
* \param do_id_user If true, id_us_plus() will be called on data when
* \param do_id_user: If true, id_us_plus() will be called on data when
* assigning it to the object.
*/
Object *BKE_object_add_for_data(
@ -1317,7 +1317,7 @@ void BKE_object_transform_copy(Object *ob_tar, const Object *ob_src)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_object_copy_data(Main *bmain, Object *ob_dst, const Object *ob_src, const int flag)
{
@ -2202,7 +2202,7 @@ void BKE_object_get_parent_matrix(Depsgraph *depsgraph, Scene *scene, Object *ob
}
/**
* \param r_originmat Optional matrix that stores the space the object is in (without its own matrix applied)
* \param r_originmat: Optional matrix that stores the space the object is in (without its own matrix applied)
*/
static void solve_parenting(Depsgraph *depsgraph,
Scene *scene, Object *ob, Object *par, float obmat[4][4], float slowmat[4][4],
@ -2379,9 +2379,9 @@ void BKE_object_workob_calc_parent(Depsgraph *depsgraph, Scene *scene, Object *o
/**
* Applies the global transformation \a mat to the \a ob using a relative parent space if supplied.
*
* \param mat the global transformation mat that the object should be set object to.
* \param parent the parent space in which this object will be set relative to (should probably always be parent_eval).
* \param use_compat true to ensure that rotations are set using the min difference between the old and new orientation.
* \param mat: the global transformation mat that the object should be set object to.
* \param parent: the parent space in which this object will be set relative to (should probably always be parent_eval).
* \param use_compat: true to ensure that rotations are set using the min difference between the old and new orientation.
*/
void BKE_object_apply_mat4_ex(Object *ob, float mat[4][4], Object *parent, float parentinv[4][4], const bool use_compat)
{
@ -3725,8 +3725,8 @@ void BKE_object_groups_clear(Main *bmain, Object *ob)
*
* \note Only mesh objects currently support deforming, others are TODO.
*
* \param ob
* \param r_tot
* \param ob:
* \param r_tot:
* \return The kdtree or NULL if it can't be created.
*/
KDTree *BKE_object_as_kdtree(Object *ob, int *r_tot)

2
source/blender/blenkernel/intern/object_deform.c
View File

@ -70,7 +70,7 @@ static Lattice *object_defgroup_lattice_get(ID *id)
*
* Use it when you remove or reorder vgroups in the object.
*
* \param map an array mapping old indices to new indices.
* \param map: an array mapping old indices to new indices.
*/
void BKE_object_defgroup_remap_update_users(Object *ob, int *map)
{

6
source/blender/blenkernel/intern/paint.c
View File

@ -444,7 +444,7 @@ PaintCurve *BKE_paint_curve_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_paint_curve_copy_data(Main *UNUSED(bmain), PaintCurve *pc_dst, const PaintCurve *pc_src, const int UNUSED(flag))
{
@ -527,7 +527,7 @@ Palette *BKE_palette_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_palette_copy_data(Main *UNUSED(bmain), Palette *palette_dst, const Palette *palette_src, const int UNUSED(flag))
{
@ -1058,7 +1058,7 @@ static bool sculpt_modifiers_active(Scene *scene, Sculpt *sd, Object *ob)
}
/**
* \param need_mask So that the evaluated mesh that is returned has mask data.
* \param need_mask: So that the evaluated mesh that is returned has mask data.
*/
void BKE_sculpt_update_mesh_elements(
Depsgraph *depsgraph, Scene *scene, Sculpt *sd, Object *ob,

2
source/blender/blenkernel/intern/particle.c
View File

@ -3286,7 +3286,7 @@ void BKE_particlesettings_twist_curve_init(ParticleSettings *part)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_particlesettings_copy_data(
Main *UNUSED(bmain), ParticleSettings *part_dst, const ParticleSettings *part_src, const int UNUSED(flag))

8
source/blender/blenkernel/intern/rigidbody.c
View File

@ -642,7 +642,7 @@ void BKE_rigidbody_calc_center_of_mass(Object *ob, float r_center[3])
/**
* Create physics sim representation of object given RigidBody settings
*
* \param rebuild Even if an instance already exists, replace it
* \param rebuild: Even if an instance already exists, replace it
*/
static void rigidbody_validate_sim_object(RigidBodyWorld *rbw, Object *ob, bool rebuild)
{
@ -770,7 +770,7 @@ static void rigidbody_constraint_set_limits(
/**
* Create physics sim representation of constraint given rigid body constraint settings
*
* \param rebuild Even if an instance already exists, replace it
* \param rebuild: Even if an instance already exists, replace it
*/
static void rigidbody_validate_sim_constraint(RigidBodyWorld *rbw, Object *ob, bool rebuild)
{
@ -1179,7 +1179,7 @@ void BKE_rigidbody_constraints_collection_validate(Scene *scene, RigidBodyWorld
/* Get RigidBody world for the given scene, creating one if needed
*
* \param scene Scene to find active Rigid Body world for
* \param scene: Scene to find active Rigid Body world for
*/
RigidBodyWorld *BKE_rigidbody_get_world(Scene *scene)
{
@ -1389,7 +1389,7 @@ static void rigidbody_update_sim_ob(Depsgraph *depsgraph, Scene *scene, RigidBod
/**
* Updates and validates world, bodies and shapes.
*
* \param rebuild Rebuild entire simulation
* \param rebuild: Rebuild entire simulation
*/
static void rigidbody_update_simulation(Depsgraph *depsgraph, Scene *scene, RigidBodyWorld *rbw, bool rebuild)
{

2
source/blender/blenkernel/intern/scene.c
View File

@ -236,7 +236,7 @@ void BKE_toolsettings_free(ToolSettings *toolsettings)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_scene_copy_data(Main *bmain, Scene *sce_dst, const Scene *sce_src, const int flag)
{

2
source/blender/blenkernel/intern/sound.c
View File

@ -159,7 +159,7 @@ void BKE_sound_free(bSound *sound)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_sound_copy_data(Main *bmain, bSound *sound_dst, const bSound *UNUSED(sound_src), const int UNUSED(flag))
{

2
source/blender/blenkernel/intern/speaker.c
View File

@ -73,7 +73,7 @@ void *BKE_speaker_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_speaker_copy_data(Main *UNUSED(bmain), Speaker *UNUSED(spk_dst), const Speaker *UNUSED(spk_src), const int UNUSED(flag))
{

2
source/blender/blenkernel/intern/text.c
View File

@ -473,7 +473,7 @@ Text *BKE_text_load(Main *bmain, const char *file, const char *relpath)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_text_copy_data(Main *UNUSED(bmain), Text *ta_dst, const Text *ta_src, const int UNUSED(flag))
{

2
source/blender/blenkernel/intern/texture.c
View File

@ -426,7 +426,7 @@ MTex *BKE_texture_mtex_add_id(ID *id, int slot)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_texture_copy_data(Main *bmain, Tex *tex_dst, const Tex *tex_src, const int flag)
{

2
source/blender/blenkernel/intern/world.c
View File

@ -112,7 +112,7 @@ World *BKE_world_add(Main *bmain, const char *name)
*
* WARNING! This function will not handle ID user count!
*
* \param flag Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
* \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
*/
void BKE_world_copy_data(Main *bmain, World *wrld_dst, const World *wrld_src, const int flag)
{

8
source/blender/blenlib/BLI_astar.h
View File

@ -90,10 +90,10 @@ void BLI_astar_solution_free(BLI_AStarSolution *as_solution);
* Callback computing the current cost (distance) to next node, and the estimated overall cost to destination node
* (A* expects this estimation to always be less or equal than actual shortest path from next node to destination one).
*
* \param link the graph link between current node and next one.
* \param node_idx_curr current node index.
* \param node_idx_next next node index.
* \param node_idx_dst destination node index.
* \param link: the graph link between current node and next one.
* \param node_idx_curr: current node index.
* \param node_idx_next: next node index.
* \param node_idx_dst: destination node index.
*/
typedef float (*astar_f_cost)(BLI_AStarGraph *as_graph, BLI_AStarSolution *as_solution, BLI_AStarGNLink *link,
const int node_idx_curr, const int node_idx_next, const int node_idx_dst);

4
source/blender/blenlib/BLI_system.h
View File

@ -41,8 +41,8 @@ char *BLI_cpu_brand_string(void);
* IP address of the machine. As such, it's only usable for identification
* purposes, and not for reachability over a network.
*
* @param buffer Character buffer to write the hostname into.
* @param bufsize Size of the character buffer, including trailing '\0'.
* \param buffer: Character buffer to write the hostname into.
* \param bufsize: Size of the character buffer, including trailing '\0'.
*/
void BLI_hostname_get(char *buffer, size_t bufsize);

2
source/blender/blenlib/PIL_time.h
View File

@ -53,7 +53,7 @@ long int PIL_check_seconds_timer_i(void);
/**
* Platform-independent sleep function.
* \param ms Number of milliseconds to sleep
* \param ms: Number of milliseconds to sleep
*/
void PIL_sleep_ms(int ms);

22
source/blender/blenlib/intern/BLI_dynstr.c
View File

@ -108,8 +108,8 @@ BLI_INLINE void *dynstr_alloc(DynStr *__restrict ds, size_t size)
/**
* Append a c-string to a DynStr.
*
* \param ds The DynStr to append to.
* \param cstr The c-string to append.
* \param ds: The DynStr to append to.
* \param cstr: The c-string to append.
*/
void BLI_dynstr_append(DynStr *__restrict ds, const char *cstr)
{
@ -131,9 +131,9 @@ void BLI_dynstr_append(DynStr *__restrict ds, const char *cstr)
/**
* Append a length clamped c-string to a DynStr.
*
* \param ds The DynStr to append to.
* \param cstr The c-string to append.
* \param len The maximum length of the c-string to copy.
* \param ds: The DynStr to append to.
* \param cstr: The c-string to append.
* \param len: The maximum length of the c-string to copy.
*/
void BLI_dynstr_nappend(DynStr *__restrict ds, const char *cstr, int len)
{
@ -209,8 +209,8 @@ void BLI_dynstr_vappendf(DynStr *__restrict ds, const char *__restrict format, v
/**
* Append a c-string to a DynStr, but with formatting like printf.
*
* \param ds The DynStr to append to.
* \param format The printf format string to use.
* \param ds: The DynStr to append to.
* \param format: The printf format string to use.
*/
void BLI_dynstr_appendf(DynStr *__restrict ds, const char *__restrict format, ...)
{
@ -271,7 +271,7 @@ void BLI_dynstr_appendf(DynStr *__restrict ds, const char *__restrict format, ..
/**
* Find the length of a DynStr.
*
* \param ds The DynStr of interest.
* \param ds: The DynStr of interest.
* \return The length of \a ds.
*/
int BLI_dynstr_get_len(DynStr *ds)
@ -308,7 +308,7 @@ void BLI_dynstr_get_cstring_ex(DynStr *__restrict ds, char *__restrict rets)
* <i> The returned c-string should be freed
* using MEM_freeN. </i>
*
* \param ds The DynStr of interest.
* \param ds: The DynStr of interest.
* \return The contents of \a ds as a c-string.
*/
char *BLI_dynstr_get_cstring(DynStr *ds)
@ -321,7 +321,7 @@ char *BLI_dynstr_get_cstring(DynStr *ds)
/**
* Clear the DynStr
*
* \param ds The DynStr to clear.
* \param ds: The DynStr to clear.
*/
void BLI_dynstr_clear(DynStr *ds)
{
@ -344,7 +344,7 @@ void BLI_dynstr_clear(DynStr *ds)
/**
* Free the DynStr
*
* \param ds The DynStr to free.
* \param ds: The DynStr to free.
*/
void BLI_dynstr_free(DynStr *ds)
{

44
source/blender/blenlib/intern/BLI_ghash.c
View File

@ -700,10 +700,10 @@ static GHash *ghash_copy(GHash *gh, GHashKeyCopyFP keycopyfp, GHashValCopyFP val
/**
* Creates a new, empty GHash.
*
* \param hashfp Hash callback.
* \param cmpfp Comparison callback.
* \param info Identifier string for the GHash.
* \param nentries_reserve Optionally reserve the number of members that the hash will hold.
* \param hashfp: Hash callback.
* \param cmpfp: Comparison callback.
* \param info: Identifier string for the GHash.
* \param nentries_reserve: Optionally reserve the number of members that the hash will hold.
* Use this to avoid resizing buckets if the size is known or can be closely approximated.
* \return An empty GHash.
*/
@ -796,7 +796,7 @@ void *BLI_ghash_replace_key(GHash *gh, void *key)
/**
* Lookup the value of \a key in \a gh.
*
* \param key The key to lookup.
* \param key: The key to lookup.
* \returns the value for \a key or NULL.
*
* \note When NULL is a valid value, use #BLI_ghash_lookup_p to differentiate a missing key
@ -822,7 +822,7 @@ void *BLI_ghash_lookup_default(GHash *gh, const void *key, void *val_default)
/**
* Lookup a pointer to the value of \a key in \a gh.
*
* \param key The key to lookup.
* \param key: The key to lookup.
* \returns the pointer to value for \a key or NULL.
*
* \note This has 2 main benefits over #BLI_ghash_lookup.
@ -895,9 +895,9 @@ bool BLI_ghash_ensure_p_ex(
/**
* Remove \a key from \a gh, or return false if the key wasn't found.
*
* \param key The key to remove.
* \param keyfreefp Optional callback to free the key.
* \param valfreefp Optional callback to free the value.
* \param key: The key to remove.
* \param keyfreefp: Optional callback to free the key.
* \param valfreefp: Optional callback to free the value.
* \return true if \a key was removed from \a gh.
*/
bool BLI_ghash_remove(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp)
@ -919,8 +919,8 @@ bool BLI_ghash_remove(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp, GHas
/**
* Remove \a key from \a gh, returning the value or NULL if the key wasn't found.
*
* \param key The key to remove.
* \param keyfreefp Optional callback to free the key.
* \param key: The key to remove.
* \param keyfreefp: Optional callback to free the key.
* \return the value of \a key int \a gh or NULL.
*/
void *BLI_ghash_popkey(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp)
@ -979,9 +979,9 @@ bool BLI_ghash_pop(
/**
* Reset \a gh clearing all entries.
*
* \param keyfreefp Optional callback to free the key.
* \param valfreefp Optional callback to free the value.
* \param nentries_reserve Optionally reserve the number of members that the hash will hold.
* \param keyfreefp: Optional callback to free the key.
* \param valfreefp: Optional callback to free the value.
* \param nentries_reserve: Optionally reserve the number of members that the hash will hold.
*/
void BLI_ghash_clear_ex(
GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp,
@ -1005,9 +1005,9 @@ void BLI_ghash_clear(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfree
/**
* Frees the GHash and its members.
*
* \param gh The GHash to free.
* \param keyfreefp Optional callback to free the key.
* \param valfreefp Optional callback to free the value.
* \param gh: The GHash to free.
* \param keyfreefp: Optional callback to free the key.
* \param valfreefp: Optional callback to free the value.
*/
void BLI_ghash_free(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp)
{
@ -1047,7 +1047,7 @@ void BLI_ghash_flag_clear(GHash *gh, uint flag)
* while the iterator is in use, and the iterator will step exactly
* BLI_ghash_len(gh) times before becoming done.
*
* \param gh The GHash to iterate over.
* \param gh: The GHash to iterate over.
* \return Pointer to a new DynStr.
*/
GHashIterator *BLI_ghashIterator_new(GHash *gh)
@ -1062,8 +1062,8 @@ GHashIterator *BLI_ghashIterator_new(GHash *gh)
* be mutated while the iterator is in use, and the iterator will
* step exactly BLI_ghash_len(gh) times before becoming done.
*
* \param ghi The GHashIterator to initialize.
* \param gh The GHash to iterate over.
* \param ghi: The GHashIterator to initialize.
* \param gh: The GHash to iterate over.
*/
void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh)
{
@ -1083,7 +1083,7 @@ void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh)
/**
* Steps the iterator to the next index.
*
* \param ghi The iterator.
* \param ghi: The iterator.
*/
void BLI_ghashIterator_step(GHashIterator *ghi)
{
@ -1101,7 +1101,7 @@ void BLI_ghashIterator_step(GHashIterator *ghi)
/**
* Free a GHashIterator.
*
* \param ghi The iterator to free.
* \param ghi: The iterator to free.
*/
void BLI_ghashIterator_free(GHashIterator *ghi)
{

2
source/blender/blenlib/intern/BLI_kdtree.c
View File

@ -420,7 +420,7 @@ static void add_nearest(KDTreeNearest *ptn, uint *found, uint n, int index,
* Find n nearest returns number of points found, with results in nearest.
* Normal is optional, but if given will limit results to points in normal direction from co.
*
* \param r_nearest An array of nearest, sized at least \a n.
* \param r_nearest: An array of nearest, sized at least \a n.
*/
int BLI_kdtree_find_nearest_n__normal(
const KDTree *tree, const float co[3], const float nor[3],

14
source/blender/blenlib/intern/BLI_mempool.c
View File

@ -210,9 +210,9 @@ static BLI_mempool_chunk *mempool_chunk_alloc(BLI_mempool *pool)
/**
* Initialize a chunk and add into \a pool->chunks
*
* \param pool The pool to add the chunk into.
* \param mpchunk The new uninitialized chunk (can be malloc'd)
* \param lasttail The last element of the previous chunk
* \param pool: The pool to add the chunk into.
* \param mpchunk: The new uninitialized chunk (can be malloc'd)
* \param lasttail: The last element of the previous chunk
* (used when building free chunks initially)
* \return The last chunk,
*/
@ -501,8 +501,8 @@ void *BLI_mempool_findelem(BLI_mempool *pool, uint index)
* Fill in \a data with pointers to each element of the mempool,
* to create lookup table.
*
* \param pool Pool to create a table from.
* \param data array of pointers at least the size of 'pool->totused'
* \param pool: Pool to create a table from.
* \param data: array of pointers at least the size of 'pool->totused'
*/
void BLI_mempool_as_table(BLI_mempool *pool, void **data)
{
@ -702,8 +702,8 @@ void *BLI_mempool_iterstep(BLI_mempool_iter *iter)
/**
* Empty the pool, as if it were just created.
*
* \param pool The pool to clear.
* \param totelem_reserve Optionally reserve how many items should be kept from clearing.
* \param pool: The pool to clear.
* \param totelem_reserve: Optionally reserve how many items should be kept from clearing.
*/
void BLI_mempool_clear_ex(BLI_mempool *pool, const int totelem_reserve)
{

12
source/blender/blenlib/intern/astar.c
View File

@ -62,7 +62,7 @@
/**
* Init a node in A* graph.
*
* \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function.
* \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function.
*/
void BLI_astar_node_init(BLI_AStarGraph *as_graph, const int node_index, void *custom_data)
{
@ -72,8 +72,8 @@ void BLI_astar_node_init(BLI_AStarGraph *as_graph, const int node_index, void *c
/**
* Add a link between two nodes of our A* graph.
*
* \param cost the 'length' of the link (actual distance between two vertices or face centers e.g.).
* \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function.
* \param cost: the 'length' of the link (actual distance between two vertices or face centers e.g.).
* \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function.
*/
void BLI_astar_node_link_add(
BLI_AStarGraph *as_graph, const int node1_index, const int node2_index, const float cost, void *custom_data)
@ -104,7 +104,7 @@ int BLI_astar_node_link_other_node(BLI_AStarGNLink *lnk, const int idx)
/**
* Initialize a solution data for given A* graph. Does not compute anything!
*
* \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function.
* \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function.
*
* \note BLI_AStarSolution stores nearly all data needed during solution compute.
*/
@ -169,7 +169,7 @@ void BLI_astar_solution_free(BLI_AStarSolution *as_solution)
*
* Nodes might be e.g. vertices, faces, ...
*
* \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function.
* \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function.
*/
void BLI_astar_graph_init(BLI_AStarGraph *as_graph, const int node_num, void *custom_data)
{
@ -198,7 +198,7 @@ void BLI_astar_graph_free(BLI_AStarGraph *as_graph)
/**
* Solve a path in given graph, using given 'cost' callback function.
*
* \param max_steps maximum number of nodes the found path may have. Useful in performance-critical usages.
* \param max_steps: maximum number of nodes the found path may have. Useful in performance-critical usages.
* If no path is found within given steps, returns false too.
* \return true if a path was found, false otherwise.
*/

16
source/blender/blenlib/intern/convexhull_2d.c
View File

@ -60,9 +60,9 @@ static float is_left(const float p0[2], const float p1[2], const float p2[2])
/**
* A.M. Andrew's monotone chain 2D convex hull algorithm
*
* \param points An array of 2D points presorted by increasing x and y-coords.
* \param n The number of points in points.
* \param r_points An array of the convex hull vertex indices (max is n).
* \param points: An array of 2D points presorted by increasing x and y-coords.
* \param n: The number of points in points.
* \param r_points: An array of the convex hull vertex indices (max is n).
* \returns the number of points in r_points.
*/
int BLI_convexhull_2d_sorted(const float (*points)[2], const int n, int r_points[])
@ -184,9 +184,9 @@ static int pointref_cmp_yx(const void *a_, const void *b_)
/**
* A.M. Andrew's monotone chain 2D convex hull algorithm
*
* \param points An array of 2D points.
* \param n The number of points in points.
* \param r_points An array of the convex hull vertex indices (max is n).
* \param points: An array of 2D points.
* \param n: The number of points in points.
* \param r_points: An array of the convex hull vertex indices (max is n).
* _must_ be allocated as ``n * 2`` because of how its used internally,
* even though the final result will be no more than \a n in size.
* \returns the number of points in r_points.
@ -239,7 +239,7 @@ int BLI_convexhull_2d(const float (*points)[2], const int n, int r_points[])
*
* Intended to be used with #BLI_convexhull_2d
*
* \param points_hull Ordered hull points
* \param points_hull: Ordered hull points
* (result of #BLI_convexhull_2d mapped to a contiguous array).
*
* \note we could return the index of the best edge too if its needed.
@ -294,7 +294,7 @@ float BLI_convexhull_aabb_fit_hull_2d(const float (*points_hull)[2], unsigned in
/**
* Wrap #BLI_convexhull_aabb_fit_hull_2d and do the convex hull calculation.
*
* \param points arbitrary 2d points.
* \param points: arbitrary 2d points.
*/
float BLI_convexhull_aabb_fit_points_2d(const float (*points)[2], unsigned int n)
{

6
source/blender/blenlib/intern/edgehash.c
View File

@ -475,7 +475,7 @@ void *BLI_edgehash_lookup_default(EdgeHash *eh, uint v0, uint v1, void *val_defa
* Remove \a key (v0, v1) from \a eh, or return false if the key wasn't found.
*
* \param v0, v1: The key to remove.
* \param valfreefp Optional callback to free the value.
* \param valfreefp: Optional callback to free the value.
* \return true if \a key was removed from \a eh.
*/
bool BLI_edgehash_remove(EdgeHash *eh, uint v0, uint v1, EdgeHashFreeFP valfreefp)
@ -613,8 +613,8 @@ EdgeHashIterator *BLI_edgehashIterator_new(EdgeHash *eh)
* be mutated while the iterator is in use, and the iterator will
* step exactly BLI_edgehash_len(eh) times before becoming done.
*
* \param ehi The EdgeHashIterator to initialize.
* \param eh The EdgeHash to iterate over.
* \param ehi: The EdgeHashIterator to initialize.
* \param eh: The EdgeHash to iterate over.
*/
void BLI_edgehashIterator_init(EdgeHashIterator *ehi, EdgeHash *eh)
{

10
source/blender/blenlib/intern/fileops.c
View File

@ -550,12 +550,12 @@ static char *strip_last_slash(const char *dir)
* prefixing it with startto, recursively scanning subdirectories, and invoking the specified
* callbacks for files and subdirectories found as appropriate.
*
* \param startfrom Top-level source path.
* \param startto Top-level destination path.
* \param callback_dir_pre Optional, to be invoked before entering a subdirectory, can return
* \param startfrom: Top-level source path.
* \param startto: Top-level destination path.
* \param callback_dir_pre: Optional, to be invoked before entering a subdirectory, can return
* RecursiveOp_Callback_StopRecurs to skip the subdirectory.
* \param callback_file Optional, to be invoked on each file found.
* \param callback_dir_post optional, to be invoked after leaving a subdirectory.
* \param callback_file: Optional, to be invoked on each file found.
* \param callback_dir_post: optional, to be invoked after leaving a subdirectory.
* \return
*/
static int recursive_operation(const char *startfrom, const char *startto,

2
source/blender/blenlib/intern/freetypefont.c
View File

@ -419,7 +419,7 @@ static int check_freetypefont(PackedFile *pf)
* Construct a new VFontData structure from
* Freetype font data in a PackedFile.
*
* \param pf The font data.
* \param pf: The font data.
* \retval A new VFontData structure, or NULL
* if unable to load.
*/

6
source/blender/blenlib/intern/gsqueue.c
View File

@ -58,7 +58,7 @@ struct _GSQueue {
/**
* Create a new GSQueue.
*
* \param elem_size The size of the structures in the queue.
* \param elem_size: The size of the structures in the queue.
* \retval The new queue
*/
GSQueue *BLI_gsqueue_new(size_t elem_size)
@ -131,7 +131,7 @@ void BLI_gsqueue_pop(GSQueue *gq, void *r_item)
/**
* Push an element onto the tail of the queue.
*
* \param item A pointer to an appropriately
* \param item: A pointer to an appropriately
* sized structure (the size passed to BLI_gsqueue_new).
*/
void BLI_gsqueue_push(GSQueue *gq, const void *item)
@ -159,7 +159,7 @@ void BLI_gsqueue_push(GSQueue *gq, const void *item)
* Push an element back onto the head of the queue (so
* it would be returned from the next call to BLI_gsqueue_pop).
*
* \param item A pointer to an appropriately
* \param item: A pointer to an appropriately
* sized structure (the size passed to BLI_gsqueue_new).
*/
void BLI_gsqueue_push_back(GSQueue *gq, const void *item)

4
source/blender/blenlib/intern/listbase.c
View File

@ -818,7 +818,7 @@ void BLI_listbase_reverse(ListBase *lb)
}
/**
* \param vlink Link to make first.
* \param vlink: Link to make first.
*/
void BLI_listbase_rotate_first(ListBase *lb, void *vlink)
{
@ -834,7 +834,7 @@ void BLI_listbase_rotate_first(ListBase *lb, void *vlink)
}
/**
* \param vlink Link to make last.
* \param vlink: Link to make last.
*/
void BLI_listbase_rotate_last(ListBase *lb, void *vlink)
{

6
source/blender/blenlib/intern/math_base_inline.c
View File

@ -348,7 +348,7 @@ MINLINE size_t clamp_z(size_t value, size_t min, size_t max)
/**
* Almost-equal for IEEE floats, using absolute difference method.
*
* \param max_diff the maximum absolute difference.
* \param max_diff: the maximum absolute difference.
*/
MINLINE int compare_ff(float a, float b, const float max_diff)
{
@ -358,9 +358,9 @@ MINLINE int compare_ff(float a, float b, const float max_diff)
/**
* Almost-equal for IEEE floats, using their integer representation (mixing ULP and absolute difference methods).
*
* \param max_diff is the maximum absolute difference (allows to take care of the near-zero area,
* \param max_diff: is the maximum absolute difference (allows to take care of the near-zero area,
* where relative difference methods cannot really work).
* \param max_ulps is the 'maximum number of floats + 1' allowed between \a a and \a b to consider them equal.
* \param max_ulps: is the 'maximum number of floats + 1' allowed between \a a and \a b to consider them equal.
*
* \see https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/
*/

22
source/blender/blenlib/intern/math_geom.c
View File

@ -361,9 +361,9 @@ void closest_to_line_segment_v3(float r_close[3], const float p[3], const float
/**
* Find the closest point on a plane.
*
* \param r_close Return coordinate
* \param plane The plane to test against.
* \param pt The point to find the nearest of
* \param r_close: Return coordinate
* \param plane: The plane to test against.
* \param pt: The point to find the nearest of
*
* \note non-unit-length planes are supported.
*/
@ -486,7 +486,7 @@ float dist_to_line_v3(const float p[3], const float l1[3], const float l2[3])
* Check if \a p is inside the 2x planes defined by ``(v1, v2, v3)``
* where the 3x points define 2x planes.
*
* \param axis_ref used when v1,v2,v3 form a line and to check if the corner is concave/convex.
* \param axis_ref: used when v1,v2,v3 form a line and to check if the corner is concave/convex.
*
* \note the distance from \a v1 & \a v3 to \a v2 doesnt matter
* (it just defines the planes).
@ -2020,11 +2020,11 @@ bool isect_point_planes_v3_negated(
/**
* Intersect line/plane.
*
* \param r_isect_co The intersection point.
* \param l1 The first point of the line.
* \param l2 The second point of the line.
* \param plane_co A point on the plane to intersect with.
* \param plane_no The direction of the plane (does not need to be normalized).
* \param r_isect_co: The intersection point.
* \param l1: The first point of the line.
* \param l2: The second point of the line.
* \param plane_co: A point on the plane to intersect with.
* \param plane_no: The direction of the plane (does not need to be normalized).
*
* \note #line_plane_factor_v3() shares logic.
*/
@ -3106,8 +3106,8 @@ bool clip_segment_v3_plane_n(
* This matrix can be applied to vectors so their 'z' axis runs along \a normal.
* In practice it means you can use x,y as 2d coords. \see
*
* \param r_mat The matrix to return.
* \param normal A unit length vector.
* \param r_mat: The matrix to return.
* \param normal: A unit length vector.
*/
void axis_dominant_v3_to_m3(float r_mat[3][3], const float normal[3])
{

4
source/blender/blenlib/intern/math_geom_inline.c
View File

@ -233,8 +233,8 @@ MINLINE int min_axis_v3(const float vec[3])
/**
* Simple method to find how many tri's we need when we already know the corner+poly count.
*
* \param poly_count The number of ngon's/tris (1-2 sided faces will give incorrect results)
* \param corner_count - also known as loops in BMesh/DNA
* \param poly_count: The number of ngon's/tris (1-2 sided faces will give incorrect results)
* \param corner_count: also known as loops in BMesh/DNA
*/
MINLINE int poly_to_tri_count(const int poly_count, const int corner_count)
{

6
source/blender/blenlib/intern/math_rotation.c
View File

@ -966,9 +966,9 @@ void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const s
*
* This takes the angle with sin/cos applied so we can avoid calculating it in some cases.
*
* \param axis rotation axis (must be normalized).
* \param angle_sin sin(angle)
* \param angle_cos cos(angle)
* \param axis: rotation axis (must be normalized).
* \param angle_sin: sin(angle)
* \param angle_cos: cos(angle)
*/
void axis_angle_normalized_to_mat3_ex(float mat[3][3], const float axis[3],
const float angle_sin, const float angle_cos)

26
source/blender/blenlib/intern/math_solvers.c
View File

@ -41,7 +41,7 @@
/**
* \brief Compute the eigen values and/or vectors of given 3D symmetric (aka adjoint) matrix.
*
* \param m3 the 3D symmetric matrix.
* \param m3: the 3D symmetric matrix.
* \return r_eigen_values the computed eigen values (NULL if not needed).
* \return r_eigen_vectors the computed eigen vectors (NULL if not needed).
*/
@ -63,7 +63,7 @@ bool BLI_eigen_solve_selfadjoint_m3(const float m3[3][3], float r_eigen_values[3
/**
* \brief Compute the SVD (Singular Values Decomposition) of given 3D matrix (m3 = USV*).
*
* \param m3 the matrix to decompose.
* \param m3: the matrix to decompose.
* \return r_U the computed left singular vector of \a m3 (NULL if not needed).
* \return r_S the computed singular values of \a m3 (NULL if not needed).
* \return r_V the computed right singular vector of \a m3 (NULL if not needed).
@ -82,7 +82,7 @@ void BLI_svd_m3(const float m3[3][3], float r_U[3][3], float r_S[3], float r_V[3
*
* Ignores a[0] and c[count-1]. Uses the Thomas algorithm, e.g. see wiki.
*
* \param r_x output vector, may be shared with any of the input ones
* \param r_x: output vector, may be shared with any of the input ones
* \return true if success
*/
bool BLI_tridiagonal_solve(const float *a, const float *b, const float *c, const float *d, float *r_x, const int count)
@ -130,7 +130,7 @@ bool BLI_tridiagonal_solve(const float *a, const float *b, const float *c, const
/**
* \brief Solve a possibly cyclic tridiagonal system using the Sherman-Morrison formula.
*
* \param r_x output vector, may be shared with any of the input ones
* \param r_x: output vector, may be shared with any of the input ones
* \return true if success
*/
bool BLI_tridiagonal_solve_cyclic(const float *a, const float *b, const float *c, const float *d, float *r_x, const int count)
@ -183,15 +183,15 @@ bool BLI_tridiagonal_solve_cyclic(const float *a, const float *b, const float *c
/**
* \brief Solve a generic f(x) = 0 equation using Newton's method.
*
* \param func_delta Callback computing the value of f(x).
* \param func_jacobian Callback computing the Jacobian matrix of the function at x.
* \param func_correction Callback for forcing the search into an arbitrary custom domain. May be NULL.
* \param userdata Data for the callbacks.
* \param epsilon Desired precision.
* \param max_iterations Limit on the iterations.
* \param trace Enables logging to console.
* \param x_init Initial solution vector.
* \param result Final result.
* \param func_delta: Callback computing the value of f(x).
* \param func_jacobian: Callback computing the Jacobian matrix of the function at x.
* \param func_correction: Callback for forcing the search into an arbitrary custom domain. May be NULL.
* \param userdata: Data for the callbacks.
* \param epsilon: Desired precision.
* \param max_iterations: Limit on the iterations.
* \param trace: Enables logging to console.
* \param x_init: Initial solution vector.
* \param result: Final result.
* \return true if success
*/
bool BLI_newton3d_solve(

14
source/blender/blenlib/intern/math_statistics.c
View File

@ -96,11 +96,11 @@ static void covariance_m_vn_ex_task_cb(
/**
* \brief Compute the covariance matrix of given set of nD coordinates.
*
* \param n the dimension of the vectors (and hence, of the covariance matrix to compute).
* \param cos_vn the nD points to compute covariance from.
* \param nbr_cos_vn the number of nD coordinates in cos_vn.
* \param center the center (or mean point) of cos_vn. If NULL, it is assumed cos_vn is already centered.
* \param use_sample_correction whether to apply sample correction
* \param n: the dimension of the vectors (and hence, of the covariance matrix to compute).
* \param cos_vn: the nD points to compute covariance from.
* \param nbr_cos_vn: the number of nD coordinates in cos_vn.
* \param center: the center (or mean point) of cos_vn. If NULL, it is assumed cos_vn is already centered.
* \param use_sample_correction: whether to apply sample correction
* (i.e. get 'sample varince' instead of 'population variance').
* \return r_covmat the computed covariance matrix.
*/
@ -133,8 +133,8 @@ void BLI_covariance_m_vn_ex(
/**
* \brief Compute the covariance matrix of given set of 3D coordinates.
*
* \param cos_v3 the 3D points to compute covariance from.
* \param nbr_cos_v3 the number of 3D coordinates in cos_v3.
* \param cos_v3: the 3D points to compute covariance from.
* \param nbr_cos_v3: the number of 3D coordinates in cos_v3.
* \return r_covmat the computed covariance matrix.
* \return r_center the computed center (mean) of 3D points (may be NULL).
*/

12
source/blender/blenlib/intern/path_util.c
View File

@ -652,10 +652,10 @@ void BLI_path_rel(char *file, const char *relfile)
* string = Foo.png, suffix = 123, separator = _
* Foo.png -> Foo_123.png
*
* \param string original (and final) string
* \param maxlen Maximum length of string
* \param suffix String to append to the original string
* \param sep Optional separator character
* \param string: original (and final) string
* \param maxlen: Maximum length of string
* \param suffix: String to append to the original string
* \param sep: Optional separator character
* \return true if succeeded
*/
bool BLI_path_suffix(char *string, size_t maxlen, const char *suffix, const char *sep)
@ -1324,8 +1324,8 @@ bool BLI_make_existing_file(const char *name)
* separators, including ensuring there is exactly one between the copies of *dir and *file,
* and between the copies of *relabase and *dir.
*
* \param relabase Optional prefix to substitute for "//" on front of *dir
* \param string Area to return result
* \param relabase: Optional prefix to substitute for "//" on front of *dir
* \param string: Area to return result
*/
void BLI_make_file_string(const char *relabase, char *string, const char *dir, const char *file)
{

96
source/blender/blenlib/intern/string.c
View File

@ -55,8 +55,8 @@
* into a newly mallocN'd string and returns it. \a str
* is assumed to be at least len bytes long.
*
* \param str The string to be duplicated
* \param len The number of bytes to duplicate
* \param str: The string to be duplicated
* \param len: The number of bytes to duplicate
* \retval Returns the duplicated string
*/
char *BLI_strdupn(const char *str, const size_t len)
@ -72,7 +72,7 @@ char *BLI_strdupn(const char *str, const size_t len)
* Duplicates the cstring \a str into a newly mallocN'd
* string and returns it.
*
* \param str The string to be duplicated
* \param str: The string to be duplicated
* \retval Returns the duplicated string
*/
char *BLI_strdup(const char *str)
@ -82,8 +82,8 @@ char *BLI_strdup(const char *str)
/**
* Appends the two strings, and returns new mallocN'ed string
* \param str1 first string for copy
* \param str2 second string for append
* \param str1: first string for copy
* \param str2: second string for append
* \retval Returns dst
*/
char *BLI_strdupcat(const char *__restrict str1, const char *__restrict str2)
@ -106,9 +106,9 @@ char *BLI_strdupcat(const char *__restrict str1, const char *__restrict str2)
* Like strncpy but ensures dst is always
* '\0' terminated.
*
* \param dst Destination for copy
* \param src Source string to copy
* \param maxncpy Maximum number of characters to copy (generally
* \param dst: Destination for copy
* \param src: Source string to copy
* \param maxncpy: Maximum number of characters to copy (generally
* the size of dst)
* \retval Returns dst
*/
@ -129,10 +129,10 @@ char *BLI_strncpy(char *__restrict dst, const char *__restrict src, const size_t
/**
* Like BLI_strncpy but ensures dst is always padded by given char, on both sides (unless src is empty).
*
* \param dst Destination for copy
* \param src Source string to copy
* \param pad the char to use for padding
* \param maxncpy Maximum number of characters to copy (generally the size of dst)
* \param dst: Destination for copy
* \param src: Source string to copy
* \param pad: the char to use for padding
* \param maxncpy: Maximum number of characters to copy (generally the size of dst)
* \retval Returns dst
*/
char *BLI_strncpy_ensure_pad(char *__restrict dst, const char *__restrict src, const char pad, size_t maxncpy)
@ -181,9 +181,9 @@ char *BLI_strncpy_ensure_pad(char *__restrict dst, const char *__restrict src, c
* \note This is a duplicate of #BLI_strncpy that returns bytes copied.
* And is a drop in replacement for 'snprintf(str, sizeof(str), "%s", arg);'
*
* \param dst Destination for copy
* \param src Source string to copy
* \param maxncpy Maximum number of characters to copy (generally
* \param dst: Destination for copy
* \param src: Source string to copy
* \param maxncpy: Maximum number of characters to copy (generally
* the size of dst)
* \retval The number of bytes copied (The only difference from BLI_strncpy).
*/
@ -413,9 +413,9 @@ char *BLI_str_quoted_substrN(const char *__restrict str, const char *__restrict
* \note A rather wasteful string-replacement utility, though this shall do for now...
* Feel free to replace this with an even safe + nicer alternative
*
* \param str The string to replace occurrences of substr_old in
* \param substr_old The text in the string to find and replace
* \param substr_new The text in the string to find and replace
* \param str: The string to replace occurrences of substr_old in
* \param substr_old: The text in the string to find and replace
* \param substr_new: The text in the string to find and replace
* \retval Returns the duplicated string
*/
char *BLI_str_replaceN(const char *__restrict str, const char *__restrict substr_old, const char *__restrict substr_new)
@ -799,8 +799,8 @@ void BLI_str_rstrip(char *str)
* 0.0000 -> 0.0
* 2.0010 -> 2.001
*
* \param str
* \param pad
* \param str:
* \param pad:
* \return The number of zeros stripped.
*/
int BLI_str_rstrip_float_zero(char *str, const char pad)
@ -826,9 +826,9 @@ int BLI_str_rstrip_float_zero(char *str, const char pad)
/**
* Return index of a string in a string array.
*
* \param str The string to find.
* \param str_array Array of strings.
* \param str_array_len The length of the array, or -1 for a NULL-terminated array.
* \param str: The string to find.
* \param str_array: Array of strings.
* \param str_array_len: The length of the array, or -1 for a NULL-terminated array.
* \return The index of str in str_array or -1.
*/
int BLI_str_index_in_array_n(const char *__restrict str, const char **__restrict str_array, const int str_array_len)
@ -847,8 +847,8 @@ int BLI_str_index_in_array_n(const char *__restrict str, const char **__restrict
/**
* Return index of a string in a string array.
*
* \param str The string to find.
* \param str_array Array of strings, (must be NULL-terminated).
* \param str: The string to find.
* \param str_array: Array of strings, (must be NULL-terminated).
* \return The index of str in str_array or -1.
*/
int BLI_str_index_in_array(const char *__restrict str, const char **__restrict str_array)
@ -883,8 +883,8 @@ bool BLI_strn_endswith(const char *__restrict str, const char *__restrict end, s
/**
* Find if a string ends with another string.
*
* \param str The string to search within.
* \param end The string we look for at the end.
* \param str: The string to search within.
* \param end: The string we look for at the end.
* \return If str ends with end.
*/
bool BLI_str_endswith(const char *__restrict str, const char * __restrict end)
@ -896,10 +896,10 @@ bool BLI_str_endswith(const char *__restrict str, const char * __restrict end)
/**
* Find the first char matching one of the chars in \a delim, from left.
*
* \param str The string to search within.
* \param delim The set of delimiters to search for, as unicode values.
* \param sep Return value, set to the first delimiter found (or NULL if none found).
* \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
* \param str: The string to search within.
* \param delim: The set of delimiters to search for, as unicode values.
* \param sep: Return value, set to the first delimiter found (or NULL if none found).
* \param suf: Return value, set to next char after the first delimiter found (or NULL if none found).
* \return The length of the prefix (i.e. *sep - str).
*/
size_t BLI_str_partition(const char *str, const char delim[], const char **sep, const char **suf)
@ -910,10 +910,10 @@ size_t BLI_str_partition(const char *str, const char delim[], const char **sep,
/**
* Find the first char matching one of the chars in \a delim, from right.
*
* \param str The string to search within.
* \param delim The set of delimiters to search for, as unicode values.
* \param sep Return value, set to the first delimiter found (or NULL if none found).
* \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
* \param str: The string to search within.
* \param delim: The set of delimiters to search for, as unicode values.
* \param sep: Return value, set to the first delimiter found (or NULL if none found).
* \param suf: Return value, set to next char after the first delimiter found (or NULL if none found).
* \return The length of the prefix (i.e. *sep - str).
*/
size_t BLI_str_rpartition(const char *str, const char delim[], const char **sep, const char **suf)
@ -924,12 +924,12 @@ size_t BLI_str_rpartition(const char *str, const char delim[], const char **sep,
/**
* Find the first char matching one of the chars in \a delim, either from left or right.
*
* \param str The string to search within.
* \param end If non-NULL, the right delimiter of the string.
* \param delim The set of delimiters to search for, as unicode values.
* \param sep Return value, set to the first delimiter found (or NULL if none found).
* \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
* \param from_right If %true, search from the right of \a str, else, search from its left.
* \param str: The string to search within.
* \param end: If non-NULL, the right delimiter of the string.
* \param delim: The set of delimiters to search for, as unicode values.
* \param sep: Return value, set to the first delimiter found (or NULL if none found).
* \param suf: Return value, set to next char after the first delimiter found (or NULL if none found).
* \param from_right: If %true, search from the right of \a str, else, search from its left.
* \return The length of the prefix (i.e. *sep - str).
*/
size_t BLI_str_partition_ex(
@ -1004,8 +1004,8 @@ static size_t BLI_str_format_int_grouped_ex(char src[16], char dst[16], int num_
* Format ints with decimal grouping.
* 1000 -> 1,000
*
* \param dst The resulting string
* \param num Number to format
* \param dst: The resulting string
* \param num: Number to format
* \return The length of \a dst
*/
size_t BLI_str_format_int_grouped(char dst[16], int num)
@ -1020,8 +1020,8 @@ size_t BLI_str_format_int_grouped(char dst[16], int num)
* Format uint64_t with decimal grouping.
* 1000 -> 1,000
*
* \param dst The resulting string
* \param num Number to format
* \param dst: The resulting string
* \param num: Number to format
* \return The length of \a dst
*/
size_t BLI_str_format_uint64_grouped(char dst[16], uint64_t num)
@ -1037,9 +1037,9 @@ size_t BLI_str_format_uint64_grouped(char dst[16], uint64_t num)
* 1000 -> 1 KB
* Number of decimal places grows with the used unit (e.g. 1.5 MB, 1.55 GB, 1.545 TB).
*
* \param dst The resulting string. Dimension of 14 to support largest possible value for \a bytes (LLONG_MAX).
* \param bytes Number to format
* \param base_10 Calculate using base 10 (GB, MB, ...) or 2 (GiB, MiB, ...)
* \param dst: The resulting string. Dimension of 14 to support largest possible value for \a bytes (LLONG_MAX).
* \param bytes: Number to format
* \param base_10: Calculate using base 10 (GB, MB, ...) or 2 (GiB, MiB, ...)
*/
void BLI_str_format_byte_unit(char dst[15], long long int bytes, const bool base_10)
{

12
source/blender/blenlib/intern/string_utf8.c
View File

@ -515,7 +515,7 @@ int BLI_str_utf8_size_safe(const char *p)
/* was g_utf8_get_char */
/**
* BLI_str_utf8_as_unicode:
* \param p a pointer to Unicode character encoded as UTF-8
* \param p: a pointer to Unicode character encoded as UTF-8
*
* Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
* If \a p does not point to a valid UTF-8 encoded character, results are
@ -677,8 +677,8 @@ size_t BLI_str_utf8_from_unicode(uint c, char *outbuf)
/* was g_utf8_find_prev_char */
/**
* BLI_str_find_prev_char_utf8:
* \param str pointer to the beginning of a UTF-8 encoded string
* \param p pointer to some position within \a str
* \param str: pointer to the beginning of a UTF-8 encoded string
* \param p: pointer to some position within \a str
*
* Given a position \a p with a UTF-8 encoded string \a str, find the start
* of the previous UTF-8 character starting before. \a p Returns %NULL if no
@ -703,8 +703,8 @@ char *BLI_str_find_prev_char_utf8(const char *str, const char *p)
/* was g_utf8_find_next_char */
/**
* BLI_str_find_next_char_utf8:
* \param p a pointer to a position within a UTF-8 encoded string
* \param end a pointer to the byte following the end of the string,
* \param p: a pointer to a position within a UTF-8 encoded string
* \param end: a pointer to the byte following the end of the string,
* or %NULL to indicate that the string is nul-terminated.
*
* Finds the start of the next UTF-8 character in the string after \a p
@ -735,7 +735,7 @@ char *BLI_str_find_next_char_utf8(const char *p, const char *end)
/* was g_utf8_prev_char */
/**
* BLI_str_prev_char_utf8:
* \param p a pointer to a position within a UTF-8 encoded string
* \param p: a pointer to a position within a UTF-8 encoded string
*
* Finds the previous UTF-8 character in the string before \a p
*

38
source/blender/blenlib/intern/string_utils.c
View File

@ -55,10 +55,10 @@
* Foo.001 -> "Foo", 1
* Returning the length of "Foo"
*
* \param left Where to return copy of part preceding delim
* \param nr Where to return value of numeric suffix
* \param name String to split
* \param delim Delimiter character
* \param left: Where to return copy of part preceding delim
* \param nr: Where to return value of numeric suffix
* \param name: String to split
* \param delim: Delimiter character
* \return Length of \a left
*/
size_t BLI_split_name_num(char *left, int *nr, const char *name, const char delim)
@ -142,9 +142,9 @@ void BLI_string_split_prefix(const char *string, char *r_pre, char *r_body, cons
/**
* Finds the best possible flipped (left/right) name. For renaming; check for unique names afterwards.
*
* \param r_name flipped name, assumed to be a pointer to a string of at least \a name_len size.
* \param from_name original name, assumed to be a pointer to a string of at least \a name_len size.
* \param strip_number If set, remove number extensions.
* \param r_name: flipped name, assumed to be a pointer to a string of at least \a name_len size.
* \param from_name: original name, assumed to be a pointer to a string of at least \a name_len size.
* \param strip_number: If set, remove number extensions.
*/
void BLI_string_flip_side_name(char *r_name, const char *from_name, const bool strip_number, const size_t name_len)
{
@ -275,12 +275,12 @@ void BLI_string_flip_side_name(char *r_name, const char *from_name, const bool s
* Ensures name is unique (according to criteria specified by caller in unique_check callback),
* incrementing its numeric suffix as necessary. Returns true if name had to be adjusted.
*
* \param unique_check Return true if name is not unique
* \param arg Additional arg to unique_check--meaning is up to caller
* \param defname To initialize name if latter is empty
* \param delim Delimits numeric suffix in name
* \param name Name to be ensured unique
* \param name_len Maximum length of name area
* \param unique_check: Return true if name is not unique
* \param arg: Additional arg to unique_check--meaning is up to caller
* \param defname: To initialize name if latter is empty
* \param delim: Delimits numeric suffix in name
* \param name: Name to be ensured unique
* \param name_len: Maximum length of name area
* \return true if there if the name was changed
*/
bool BLI_uniquename_cb(
@ -359,12 +359,12 @@ static bool uniquename_unique_check(void *arg, const char *name)
* Ensures that the specified block has a unique name within the containing list,
* incrementing its numeric suffix as necessary. Returns true if name had to be adjusted.
*
* \param list List containing the block
* \param vlink The block to check the name for
* \param defname To initialize block name if latter is empty
* \param delim Delimits numeric suffix in name
* \param name_offs Offset of name within block structure
* \param name_len Maximum length of name area
* \param list: List containing the block
* \param vlink: The block to check the name for
* \param defname: To initialize block name if latter is empty
* \param delim: Delimits numeric suffix in name
* \param name_offs: Offset of name within block structure
* \param name_len: Maximum length of name area
*/
bool BLI_uniquename(ListBase *list, void *vlink, const char *defname, char delim, int name_offs, size_t name_len)
{

8
source/blender/blenlib/intern/task.c
View File

@ -1263,10 +1263,10 @@ BLI_INLINE int task_parallel_listbasecalc_chunk_size(const int num_threads)
/**
* This function allows to parallelize for loops over ListBase items.
*
* \param listbase The double linked list 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
* \param listbase: The double linked list 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).
*
* \note There is no static scheduling here, since it would need another full loop over items to count them...

20
source/blender/blenlib/intern/timecode.c
View File

@ -46,13 +46,13 @@
/**
* Generate timecode/frame number string and store in \a str
*
* \param str destination string
* \param maxncpy maximum number of characters to copy ``sizeof(str)``
* \param power special setting for #View2D grid drawing,
* \param str: destination string
* \param maxncpy: maximum number of characters to copy ``sizeof(str)``
* \param power: special setting for #View2D grid drawing,
* used to specify how detailed we need to be
* \param time_seconds time total time in seconds
* \param fps frames per second, typically from the #FPS macro
* \param timecode_style enum from eTimecodeStyles
* \param time_seconds: time total time in seconds
* \param fps: frames per second, typically from the #FPS macro
* \param timecode_style: enum from eTimecodeStyles
* \return length of \a str
*/
@ -231,11 +231,11 @@ size_t BLI_timecode_string_from_time_simple(
/**
* Generate time string and store in \a str
*
* \param str destination string
* \param maxncpy maximum number of characters to copy ``sizeof(str)``
* \param power special setting for #View2D grid drawing,
* \param str: destination string
* \param maxncpy: maximum number of characters to copy ``sizeof(str)``
* \param power: special setting for #View2D grid drawing,
* used to specify how detailed we need to be
* \param time_seconds time total time in seconds
* \param time_seconds: time total time in seconds
* \return length of \a str
*
* \note in some cases this is used to print non-seconds values.

40
source/blender/blenloader/intern/readblenentry.c
View File

@ -75,8 +75,8 @@ void BLO_blendhandle_print_sizes(BlendHandle *, void *);
/**
* Open a blendhandle from a file path.
*
* \param filepath The file path to open.
* \param reports Report errors in opening the file (can be NULL).
* \param filepath: The file path to open.
* \param reports: Report errors in opening the file (can be NULL).
* \return A handle on success, or NULL on failure.
*/
BlendHandle *BLO_blendhandle_from_file(const char *filepath, ReportList *reports)
@ -91,8 +91,8 @@ BlendHandle *BLO_blendhandle_from_file(const char *filepath, ReportList *reports
/**
* Open a blendhandle from memory.
*
* \param mem The data to load from.
* \param memsize The size of the data.
* \param mem: The data to load from.
* \param memsize: The size of the data.
* \return A handle on success, or NULL on failure.
*/
BlendHandle *BLO_blendhandle_from_memory(const void *mem, int memsize)
@ -137,9 +137,9 @@ void BLO_blendhandle_print_sizes(BlendHandle *bh, void *fp)
/**
* Gets the names of all the datablocks in a file of a certain type (e.g. all the scene names in a file).
*
* \param bh The blendhandle to access.
* \param ofblocktype The type of names to get.
* \param tot_names The length of the returned list.
* \param bh: The blendhandle to access.
* \param ofblocktype: The type of names to get.
* \param tot_names: The length of the returned list.
* \return A BLI_linklist of strings. The string links should be freed with malloc.
*/
LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh, int ofblocktype, int *tot_names)
@ -167,9 +167,9 @@ LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh, int ofblocktype,
/**
* Gets the previews of all the datablocks in a file of a certain type (e.g. all the scene previews in a file).
*
* \param bh The blendhandle to access.
* \param ofblocktype The type of names to get.
* \param tot_prev The length of the returned list.
* \param bh: The blendhandle to access.
* \param ofblocktype: The type of names to get.
* \param tot_prev: The length of the returned list.
* \return A BLI_linklist of PreviewImage. The PreviewImage links should be freed with malloc.
*/
LinkNode *BLO_blendhandle_get_previews(BlendHandle *bh, int ofblocktype, int *tot_prev)
@ -265,7 +265,7 @@ LinkNode *BLO_blendhandle_get_previews(BlendHandle *bh, int ofblocktype, int *to
/**
* Gets the names of all the linkable datablock types available in a file. (e.g. "Scene", "Mesh", "Lamp", etc.).
*
* \param bh The blendhandle to access.
* \param bh: The blendhandle to access.
* \return A BLI_linklist of strings. The string links should be freed with malloc.
*/
LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh)
@ -298,7 +298,7 @@ LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh)
/**
* Close and free a blendhandle. The handle becomes invalid after this call.
*
* \param bh The handle to close.
* \param bh: The handle to close.
*/
void BLO_blendhandle_close(BlendHandle *bh)
{
@ -313,8 +313,8 @@ void BLO_blendhandle_close(BlendHandle *bh)
* Open a blender file from a pathname. The function returns NULL
* and sets a report in the list if it cannot open the file.
*
* \param filepath The path of the file to open.
* \param reports If the return value is NULL, errors indicating the cause of the failure.
* \param filepath: The path of the file to open.
* \param reports: If the return value is NULL, errors indicating the cause of the failure.
* \return The data of the file.
*/
BlendFileData *BLO_read_from_file(
@ -340,9 +340,9 @@ BlendFileData *BLO_read_from_file(
* Open a blender file from memory. The function returns NULL
* and sets a report in the list if it cannot open the file.
*
* \param mem The file data.
* \param memsize The length of \a mem.
* \param reports If the return value is NULL, errors indicating the cause of the failure.
* \param mem: The file data.
* \param memsize: The length of \a mem.
* \param reports: If the return value is NULL, errors indicating the cause of the failure.
* \return The data of the file.
*/
BlendFileData *BLO_read_from_memory(
@ -367,8 +367,8 @@ BlendFileData *BLO_read_from_memory(
/**
* Used for undo/redo, skips part of libraries reading (assuming their data are already loaded & valid).
*
* \param oldmain old main, from which we will keep libraries and other datablocks that should not have changed.
* \param filename current file, only for retrieving library data.
* \param oldmain: old main, from which we will keep libraries and other datablocks that should not have changed.
* \param filename: current file, only for retrieving library data.
*/
BlendFileData *BLO_read_from_memfile(
Main *oldmain, const char *filename, MemFile *memfile,
@ -469,7 +469,7 @@ BlendFileData *BLO_read_from_memfile(
/**
* Frees a BlendFileData structure and *all* the data associated with it (the userdef data, and the main libblock data).
*
* \param bfd The structure to free.
* \param bfd: The structure to free.
*/
void BLO_blendfiledata_free(BlendFileData *bfd)
{

58
source/blender/blenloader/intern/readfile.c
View File

@ -1362,7 +1362,7 @@ void blo_freefiledata(FileData *fd)
/**
* Check whether given path ends with a blend file compatible extension (.blend, .ble or .blend.gz).
*
* \param str The path to check.
* \param str: The path to check.
* \return true is this path ends with a blender file extension.
*/
bool BLO_has_bfile_extension(const char *str)
@ -1374,11 +1374,11 @@ bool BLO_has_bfile_extension(const char *str)
/**
* Try to explode given path into its 'library components' (i.e. a .blend file, id type/group, and datablock itself).
*
* \param path the full path to explode.
* \param r_dir the string that'll contain path up to blend file itself ('library' path).
* \param path: the full path to explode.
* \param r_dir: the string that'll contain path up to blend file itself ('library' path).
* WARNING! Must be FILE_MAX_LIBEXTRA long (it also stores group and name strings)!
* \param r_group the string that'll contain 'group' part of the path, if any. May be NULL.
* \param r_name the string that'll contain data's name part of the path, if any. May be NULL.
* \param r_group: the string that'll contain 'group' part of the path, if any. May be NULL.
* \param r_name: the string that'll contain data's name part of the path, if any. May be NULL.
* \return true if path contains a blend file.
*/
bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, char **r_name)
@ -1443,7 +1443,7 @@ bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, cha
/**
* Does a very light reading of given .blend file to extract its stored thumbnail.
*
* \param filepath The path of the file to extract thumbnail from.
* \param filepath: The path of the file to extract thumbnail from.
* \return The raw thumbnail
* (MEM-allocated, as stored in file, use BKE_main_thumbnail_to_imbuf() to convert it to ImBuf image).
*/
@ -10160,7 +10160,7 @@ static void expand_workspace(FileData *fd, Main *mainvar, WorkSpace *workspace)
/**
* Set the callback func used over all ID data found by \a BLO_expand_main func.
*
* \param expand_doit_func Called for each ID block it finds.
* \param expand_doit_func: Called for each ID block it finds.
*/
void BLO_main_expander(BLOExpandDoitCallback expand_doit_func)
{
@ -10171,8 +10171,8 @@ void BLO_main_expander(BLOExpandDoitCallback expand_doit_func)
* Loop over all ID data in Main to mark relations.
* Set (id->tag & LIB_TAG_NEED_EXPAND) to mark expanding. Flags get cleared after expanding.
*
* \param fdhandle usually filedata, or own handle.
* \param mainvar the Main database to expand.
* \param fdhandle: usually filedata, or own handle.
* \param mainvar: the Main database to expand.
*/
void BLO_expand_main(void *fdhandle, Main *mainvar)
{
@ -10562,10 +10562,10 @@ static ID *link_named_part_ex(
/**
* Link a named datablock from an external blend file.
*
* \param mainl The main database to link from (not the active one).
* \param bh The blender file handle.
* \param idcode The kind of datablock to link.
* \param name The name of the datablock (without the 2 char ID prefix).
* \param mainl: The main database to link from (not the active one).
* \param bh: The blender file handle.
* \param idcode: The kind of datablock to link.
* \param name: The name of the datablock (without the 2 char ID prefix).
* \return the linked ID when found.
*/
ID *BLO_library_link_named_part(Main *mainl, BlendHandle **bh, const short idcode, const char *name)
@ -10578,13 +10578,13 @@ ID *BLO_library_link_named_part(Main *mainl, BlendHandle **bh, const short idcod
* Link a named datablock from an external blend file.
* Optionally instantiate the object/collection in the scene when the flags are set.
*
* \param mainl The main database to link from (not the active one).
* \param bh The blender file handle.
* \param idcode The kind of datablock to link.
* \param name The name of the datablock (without the 2 char ID prefix).
* \param flag Options for linking, used for instantiating.
* \param scene The scene in which to instantiate objects/collections (if NULL, no instantiation is done).
* \param v3d The active View3D (only to define active layers for instantiated objects & collections, can be NULL).
* \param mainl: The main database to link from (not the active one).
* \param bh: The blender file handle.
* \param idcode: The kind of datablock to link.
* \param name: The name of the datablock (without the 2 char ID prefix).
* \param flag: Options for linking, used for instantiating.
* \param scene: The scene in which to instantiate objects/collections (if NULL, no instantiation is done).
* \param v3d: The active View3D (only to define active layers for instantiated objects & collections, can be NULL).
* \return the linked ID when found.
*/
ID *BLO_library_link_named_part_ex(
@ -10668,9 +10668,9 @@ static Main *library_link_begin(Main *mainvar, FileData **fd, const char *filepa
/**
* Initialize the BlendHandle for linking library data.
*
* \param mainvar The current main database, e.g. G_MAIN or CTX_data_main(C).
* \param bh A blender file handle as returned by \a BLO_blendhandle_from_file or \a BLO_blendhandle_from_memory.
* \param filepath Used for relative linking, copied to the \a lib->name.
* \param mainvar: The current main database, e.g. G_MAIN or CTX_data_main(C).
* \param bh: A blender file handle as returned by \a BLO_blendhandle_from_file or \a BLO_blendhandle_from_memory.
* \param filepath: Used for relative linking, copied to the \a lib->name.
* \return the library Main, to be passed to \a BLO_library_append_named_part as \a mainl.
*/
Main *BLO_library_link_begin(Main *mainvar, BlendHandle **bh, const char *filepath)
@ -10786,12 +10786,12 @@ static void library_link_end(Main *mainl, FileData **fd, const short flag, Main
* Optionally instance the indirect object/collection in the scene when the flags are set.
* \note Do not use \a bh after calling this function, it may frees it.
*
* \param mainl The main database to link from (not the active one).
* \param bh The blender file handle (WARNING! may be freed by this function!).
* \param flag Options for linking, used for instantiating.
* \param bmain The main database in which to instantiate objects/collections
* \param scene The scene in which to instantiate objects/collections (if NULL, no instantiation is done).
* \param view_layer The scene layer in which to instantiate objects/collections (if NULL, no instantiation is done).
* \param mainl: The main database to link from (not the active one).
* \param bh: The blender file handle (WARNING! may be freed by this function!).
* \param flag: Options for linking, used for instantiating.
* \param bmain: The main database in which to instantiate objects/collections
* \param scene: The scene in which to instantiate objects/collections (if NULL, no instantiation is done).
* \param view_layer: The scene layer in which to instantiate objects/collections (if NULL, no instantiation is done).
*/
void BLO_library_link_end(Main *mainl, BlendHandle **bh, int flag, Main *bmain, Scene *scene, ViewLayer *view_layer)
{

8
source/blender/blenloader/intern/writefile.c
View File

@ -412,8 +412,8 @@ static void mywrite_flush(WriteData *wd)
/**
* Low level WRITE(2) wrapper that buffers data
* \param adr Pointer to new chunk of data
* \param len Length of new chunk of data
* \param adr: Pointer to new chunk of data
* \param len: Length of new chunk of data
*/
static void mywrite(WriteData *wd, const void *adr, int len)
{
@ -462,8 +462,8 @@ static void mywrite(WriteData *wd, const void *adr, int len)
/**
* BeGiN initializer for mywrite
* \param ww: File write wrapper.
* \param compare Previous memory file (can be NULL).
* \param current The current memory file (can be NULL).
* \param compare: Previous memory file (can be NULL).
* \param current: The current memory file (can be NULL).
* \warning Talks to other functions with global parameters
*/
static WriteData *mywrite_begin(WriteWrap *ww, MemFile *compare, MemFile *current)

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

@ -127,7 +127,7 @@ BMFace *BM_face_create_quad_tri(
/**
* \brief copies face loop data from shared adjacent faces.
*
* \param filter_fn A function that filters the source loops before copying (don't always want to copy all)
* \param filter_fn: A function that filters the source loops before copying (don't always want to copy all)
*
* \note when a matching edge is found, both loops of that edge are copied
* this is done since the face may not be completely surrounded by faces,

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

@ -421,11 +421,11 @@ BLI_INLINE BMFace *bm_face_create__internal(BMesh *bm)
/**
* Main face creation function
*
* \param bm The mesh
* \param verts A sorted array of verts size of len
* \param edges A sorted array of edges size of len
* \param len Length of the face
* \param create_flag Options for creating the face
* \param bm: The mesh
* \param verts: A sorted array of verts size of len
* \param edges: A sorted array of edges size of len
* \param len: Length of the face
* \param create_flag: Options for creating the face
*/
BMFace *BM_face_create(
BMesh *bm, BMVert **verts, BMEdge **edges, const int len,
@ -2396,7 +2396,7 @@ void bmesh_kernel_vert_separate(
*
* Any edges which failed to split off in #bmesh_kernel_vert_separate will be merged back into the original edge.
*
* \param edges_separate
* \param edges_separate:
* A list-of-lists, each list is from a single original edge (the first edge is the original),
* Check for duplicates (not just with the first) but between all.
* This is O(n2) but radial edges are very rarely >2 and almost never >~10.

2
source/blender/bmesh/intern/bmesh_mesh_conv.c
View File

@ -552,7 +552,7 @@ BLI_INLINE void bmesh_quick_edgedraw_flag(MEdge *med, BMEdge *e)
/**
*
* \param bmain May be NULL in case \a calc_object_remap parameter option is not set.
* \param bmain: May be NULL in case \a calc_object_remap parameter option is not set.
*/
void BM_mesh_bm_to_me(
Main *bmain, BMesh *bm, Mesh *me,

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

@ -247,12 +247,12 @@ BMFace *BM_faces_join_pair(BMesh *bm, BMLoop *l_a, BMLoop *l_b, const bool do_de
* Split a face along two vertices. returns the newly made face, and sets
* the \a r_l member to a loop in the newly created edge.
*
* \param bm The bmesh
* \param f the original face
* \param l_a, l_b Loops of this face, their vertices define
* \param bm: The bmesh
* \param f: the original face
* \param l_a, l_b: Loops of this face, their vertices define
* the split edge to be created (must be differ and not can't be adjacent in the face).
* \param r_l pointer which will receive the BMLoop for the split edge in the new face
* \param example Edge used for attributes of splitting edge, if non-NULL
* \param r_l: pointer which will receive the BMLoop for the split edge in the new face
* \param example: Edge used for attributes of splitting edge, if non-NULL
* \param no_double: Use an existing edge if found
*
* \return Pointer to the newly created face representing one side of the split
@ -327,13 +327,13 @@ BMFace *BM_face_split(
*
* Like BM_face_split, but with an edge split by \a n intermediate points with given coordinates.
*
* \param bm The bmesh
* \param f the original face
* \param l_a, l_b vertices which define the split edge, must be different
* \param cos Array of coordinates for intermediate points
* \param n Length of \a cos (must be > 0)
* \param r_l pointer which will receive the BMLoop for the first split edge (from \a l_a) in the new face
* \param example Edge used for attributes of splitting edge, if non-NULL
* \param bm: The bmesh
* \param f: the original face
* \param l_a, l_b: Vertices which define the split edge, must be different
* \param cos: Array of coordinates for intermediate points
* \param n: Length of \a cos (must be > 0)
* \param r_l: pointer which will receive the BMLoop for the first split edge (from \a l_a) in the new face
* \param example: Edge used for attributes of splitting edge, if non-NULL
*
* \return Pointer to the newly created face representing one side of the split
* if the split is successful (and the original original face will be the
@ -422,13 +422,13 @@ BMFace *BM_face_split_n(
* both collapse a vertex and return a new edge.
* Except this takes a factor and merges custom data.
*
* \param bm The bmesh
* \param e_kill The edge to collapse
* \param v_kill The vertex to collapse into the edge
* \param fac The factor along the edge
* \param join_faces When true the faces around the vertex will be joined
* \param bm: The bmesh
* \param e_kill: The edge to collapse
* \param v_kill: The vertex to collapse into the edge
* \param fac: The factor along the edge
* \param join_faces: When true the faces around the vertex will be joined
* otherwise collapse the vertex by merging the 2 edges this vert touches into one.
* \param kill_degenerate_faces Removes faces with less than 3 verts after collapsing.
* \param kill_degenerate_faces: Removes faces with less than 3 verts after collapsing.
*
* \returns The New Edge
*/
@ -580,10 +580,10 @@ BMVert *BM_edge_collapse(
* r_e e
* </pre>
*
* \param e The edge to split.
* \param v One of the vertices in \a e and defines the "from" end of the splitting operation,
* \param e: The edge to split.
* \param v: One of the vertices in \a e and defines the "from" end of the splitting operation,
* the new vertex will be \a fac of the way from \a v to the other end.
* \param r_e The newly created edge.
* \param r_e: The newly created edge.
* \return The new vertex.
*/
BMVert *BM_edge_split(BMesh *bm, BMEdge *e, BMVert *v, BMEdge **r_e, float fac)
@ -703,7 +703,7 @@ BMVert *BM_edge_split(BMesh *bm, BMEdge *e, BMVert *v, BMEdge **r_e, float fac)
/**
* \brief Split an edge multiple times evenly
*
* \param r_varr Optional array, verts in between (v1 -> v2)
* \param r_varr: Optional array, verts in between (v1 -> v2)
*/
BMVert *BM_edge_split_n(BMesh *bm, BMEdge *e, int numcuts, BMVert **r_varr)
{
@ -857,8 +857,8 @@ bool BM_edge_rotate_check(BMEdge *e)
* 1) does the newly forms edge form a flipped face (compare with previous cross product)
* 2) does the newly formed edge cause a zero area corner (or close enough to be almost zero)
*
* \param e The edge to test rotation.
* \param l1,l2 are the loops of the proposed verts to rotate too and should
* \param e: The edge to test rotation.
* \param l1, l2: are the loops of the proposed verts to rotate too and should
* be the result of calling #BM_edge_calc_rotate
*/
bool BM_edge_rotate_check_degenerate(BMEdge *e, BMLoop *l1, BMLoop *l2)

2
source/blender/bmesh/intern/bmesh_operators.c
View File

@ -1379,7 +1379,7 @@ void *BMO_slot_buffer_get_first(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char
/**
* \brief New Iterator
*
* \param restrictmask restricts the iteration to certain element types
* \param restrictmask: restricts the iteration to certain element types
* (e.g. combination of BM_VERT, BM_EDGE, BM_FACE), if iterating
* over an element buffer (not a mapping). */
void *BMO_iter_new(

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

@ -950,7 +950,7 @@ bool BM_face_point_inside_test(const BMFace *f, const float co[3])
* It uses polyfill for the ngons splitting, and
* the beautify operator when use_beauty is true.
*
* \param r_faces_new if non-null, must be an array of BMFace pointers,
* \param r_faces_new: if non-null, must be an array of BMFace pointers,
* with a length equal to (f->len - 3). It will be filled with the new
* triangles (not including the original triangle).
*
@ -1393,7 +1393,7 @@ void BM_face_as_array_loop_quad(BMFace *f, BMLoop *r_loops[4])
/**
* \brief BM_mesh_calc_tessellation get the looptris and its number from a certain bmesh
* \param looptris
* \param looptris:
*
* \note \a looptris Must be pre-allocated to at least the size of given by: poly_to_tri_count
*/

52
source/blender/bmesh/intern/bmesh_query.c
View File

@ -1573,8 +1573,8 @@ float BM_loop_calc_face_normal_safe(const BMLoop *l, float r_normal[3])
*
* 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 r_normal Resulting normal
* \param l: The loop to calculate the normal at
* \param r_normal: Resulting normal
* \return The length of the cross product (double the area).
*/
float BM_loop_calc_face_normal(const BMLoop *l, float r_normal[3])
@ -1596,8 +1596,8 @@ float BM_loop_calc_face_normal(const BMLoop *l, float r_normal[3])
*
* Calculate the direction a loop is pointing.
*
* \param l The loop to calculate the direction at
* \param r_dir Resulting direction
* \param l: The loop to calculate the direction at
* \param r_dir: Resulting direction
*/
void BM_loop_calc_face_direction(const BMLoop *l, float r_dir[3])
{
@ -1620,8 +1620,8 @@ void BM_loop_calc_face_direction(const BMLoop *l, float r_dir[3])
* Calculate the tangent at this loop corner or fallback to the face normal on straight lines.
* This vector always points inward into the face.
*
* \param l The loop to calculate the tangent at
* \param r_tangent Resulting tangent
* \param l: The loop to calculate the tangent at
* \param r_tangent: Resulting tangent
*/
void BM_loop_calc_face_tangent(const BMLoop *l, float r_tangent[3])
{
@ -1743,10 +1743,10 @@ float BM_edge_calc_face_angle_signed(const BMEdge *e)
* This vector always points inward into the face.
*
* \brief BM_edge_calc_face_tangent
* \param e
* \param e_loop The loop to calculate the tangent at,
* \param e:
* \param e_loop: The loop to calculate the tangent at,
* used to get the face and winding direction.
* \param r_tangent The loop corner tangent to set
* \param r_tangent: The loop corner tangent to set
*/
void BM_edge_calc_face_tangent(const BMEdge *e, const BMLoop *e_loop, float r_tangent[3])
@ -2246,8 +2246,8 @@ bool BM_face_exists_multi_edge(BMEdge **earr, int len)
* \note Its possible there are more than one overlapping faces,
* in this case the first one found will be returned.
*
* \param varr Array of unordered verts.
* \param len \a varr array length.
* \param varr: Array of unordered verts.
* \param len: \a varr array length.
* \return The face or NULL.
*/
@ -2294,8 +2294,8 @@ BMFace *BM_face_exists_overlap(BMVert **varr, const int len)
* there is a face that uses vertices only from this list
* (that the face is a subset or made from the vertices given).
*
* \param varr Array of unordered verts.
* \param len varr array length.
* \param varr: Array of unordered verts.
* \param len: varr array length.
*/
bool BM_face_exists_overlap_subset(BMVert **varr, const int len)
{
@ -2504,16 +2504,16 @@ float BM_mesh_calc_volume(BMesh *bm, bool is_signed)
/**
* Calculate isolated groups of faces with optional filtering.
*
* \param bm the BMesh.
* \param r_groups_array Array of ints to fill in, length of bm->totface
* \param bm: the BMesh.
* \param r_groups_array: Array of ints to fill in, length of bm->totface
* (or when hflag_test is set, the number of flagged faces).
* \param r_group_index index, length pairs into \a r_groups_array, size of return value
* \param r_group_index: index, length pairs into \a r_groups_array, size of return value
* int pairs: (array_start, array_length).
* \param filter_fn Filter the edge-loops or vert-loops we step over (depends on \a htype_step).
* \param user_data Optional user data for \a filter_fn, can be NULL.
* \param hflag_test Optional flag to test faces,
* \param filter_fn: Filter the edge-loops or vert-loops we step over (depends on \a htype_step).
* \param user_data: Optional user data for \a filter_fn, can be NULL.
* \param hflag_test: Optional flag to test faces,
* use to exclude faces from the calculation, 0 for all faces.
* \param htype_step BM_VERT to walk over face-verts, BM_EDGE to walk over faces edges
* \param htype_step: BM_VERT to walk over face-verts, BM_EDGE to walk over faces edges
* (having both set is supported too).
* \return The number of groups found.
*/
@ -2660,15 +2660,15 @@ int BM_mesh_calc_face_groups(
/**
* Calculate isolated groups of edges with optional filtering.
*
* \param bm the BMesh.
* \param r_groups_array Array of ints to fill in, length of bm->totedge
* \param bm: the BMesh.
* \param r_groups_array: Array of ints to fill in, length of bm->totedge
* (or when hflag_test is set, the number of flagged edges).
* \param r_group_index index, length pairs into \a r_groups_array, size of return value
* \param r_group_index: index, length pairs into \a r_groups_array, size of return value
* int pairs: (array_start, array_length).
* \param filter_fn Filter the edges or verts we step over (depends on \a htype_step)
* \param filter_fn: Filter the edges or verts we step over (depends on \a htype_step)
* as to which types we deal with.
* \param user_data Optional user data for \a filter_fn, can be NULL.
* \param hflag_test Optional flag to test edges,
* \param user_data: Optional user data for \a filter_fn, can be NULL.
* \param hflag_test: Optional flag to test edges,
* use to exclude edges from the calculation, 0 for all edges.
* \return The number of groups found.
*

2
source/blender/bmesh/operators/bmo_fill_grid.c
View File

@ -216,7 +216,7 @@ static void barycentric_weights_v2_grid_cache(
/**
* This may be useful outside the bmesh operator.
*
* \param v_grid 2d array of verts, all boundary verts must be set, we fill in the middle.
* \param v_grid: 2d array of verts, all boundary verts must be set, we fill in the middle.
*/
static void bm_grid_fill_array(
BMesh *bm, BMVert **v_grid, const uint xtot, unsigned const int ytot,

8
source/blender/bmesh/operators/bmo_normals.c
View File

@ -191,10 +191,10 @@ static int recalc_face_normals_find_index(BMesh *bm, BMFace **faces, const int f
* Given an array of faces, recalculate their normals.
* this functions assumes all faces in the array are connected by edges.
*
* \param bm
* \param faces Array of connected faces.
* \param faces_len Length of \a faces
* \param oflag Flag to check before doing the actual face flipping.
* \param bm:
* \param faces: Array of connected faces.
* \param faces_len: Length of \a faces
* \param oflag: Flag to check before doing the actual face flipping.
*/
static void bmo_recalc_face_normals_array(BMesh *bm, BMFace **faces, const int faces_len, const short oflag)
{

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

@ -823,10 +823,10 @@ void bmo_create_grid_exec(BMesh *bm, BMOperator *op)
/**
* Fills first available UVmap with grid-like UVs for all faces OpFlag-ged by given flag.
*
* \param bm The BMesh to operate on
* \param x_segments The x-resolution of the grid
* \param y_segments The y-resolution of the grid
* \param oflag The flag to check faces with.
* \param bm: The BMesh to operate on
* \param x_segments: The x-resolution of the grid
* \param y_segments: The y-resolution of the grid
* \param oflag: The flag to check faces with.
*/
void BM_mesh_calc_uvs_grid(
BMesh *bm, const uint x_segments, const uint y_segments,
@ -1159,8 +1159,8 @@ static void bm_mesh_calc_uvs_sphere_face(BMFace *f, const int cd_loop_uv_offset)
/**
* Fills first available UVmap with spherical projected UVs for all faces OpFlag-ged by given flag.
*
* \param bm The BMesh to operate on
* \param oflag The flag to check faces with.
* \param bm: The BMesh to operate on
* \param oflag: The flag to check faces with.
*/
void BM_mesh_calc_uvs_sphere(
BMesh *bm,
@ -1365,10 +1365,10 @@ void bmo_create_circle_exec(BMesh *bm, BMOperator *op)
/**
* Fills first available UVmap with 2D projected UVs for all faces OpFlag-ged by given flag.
*
* \param bm The BMesh to operate on.
* \param mat The transform matrix applied to the created circle.
* \param radius The size of the circle.
* \param oflag The flag to check faces with.
* \param bm: The BMesh to operate on.
* \param mat: The transform matrix applied to the created circle.
* \param radius: The size of the circle.
* \param oflag: The flag to check faces with.
*/
void BM_mesh_calc_uvs_circle(
BMesh *bm, float mat[4][4], const float radius,
@ -1530,13 +1530,13 @@ void bmo_create_cone_exec(BMesh *bm, BMOperator *op)
/**
* Fills first available UVmap with cylinder/cone-like UVs for all faces OpFlag-ged by given flag.
*
* \param bm The BMesh to operate on.
* \param mat The transform matrix applied to the created cone/cylinder.
* \param radius_top The size of the top end of the cone/cylinder.
* \param radius_bottom The size of the bottom end of the cone/cylinder.
* \param segments The number of subdivisions in the sides of the cone/cylinder.
* \param cap_ends Whether the ends of the cone/cylinder are filled or not.
* \param oflag The flag to check faces with.
* \param bm: The BMesh to operate on.
* \param mat: The transform matrix applied to the created cone/cylinder.
* \param radius_top: The size of the top end of the cone/cylinder.
* \param radius_bottom: The size of the bottom end of the cone/cylinder.
* \param segments: The number of subdivisions in the sides of the cone/cylinder.
* \param cap_ends: Whether the ends of the cone/cylinder are filled or not.
* \param oflag: The flag to check faces with.
*/
void BM_mesh_calc_uvs_cone(
BMesh *bm, float mat[4][4],
@ -1696,8 +1696,8 @@ void bmo_create_cube_exec(BMesh *bm, BMOperator *op)
* \note Expects tagged faces to be six quads.
* \note Caller must order faces for correct alignment.
*
* \param bm The BMesh to operate on.
* \param oflag The flag to check faces with.
* \param bm: The BMesh to operate on.
* \param oflag: The flag to check faces with.
*/
void BM_mesh_calc_uvs_cube(BMesh *bm, const short oflag)
{

6
source/blender/bmesh/tools/bmesh_bisect_plane.c
View File

@ -302,9 +302,9 @@ finally:
/* Main logic */
/**
* \param use_snap_center Snap verts onto the plane.
* \param use_tag Only bisect tagged edges and faces.
* \param oflag_center Operator flag, enabled for geometry on the axis (existing and created)
* \param use_snap_center: Snap verts onto the plane.
* \param use_tag: Only bisect tagged edges and faces.
* \param oflag_center: Operator flag, enabled for geometry on the axis (existing and created)
*/
void BM_mesh_bisect_plane(
BMesh *bm, const float plane[4],

8
source/blender/bmesh/tools/bmesh_decimate_collapse.c
View File

@ -84,7 +84,7 @@ typedef enum CD_UseFlag {
* ********************** */
/**
* \param vquadrics must be calloc'd
* \param vquadrics: must be calloc'd
*/
static void bm_decim_build_quadrics(BMesh *bm, Quadric *vquadrics)
{
@ -1281,9 +1281,9 @@ static bool bm_decim_edge_collapse(
/**
* \brief BM_mesh_decimate
* \param bm The mesh
* \param factor face count multiplier [0 - 1]
* \param vweights Optional array of vertex aligned weights [0 - 1],
* \param bm: The mesh
* \param factor: face count multiplier [0 - 1]
* \param vweights: Optional array of vertex aligned weights [0 - 1],
* a vertex group is the usual source for this.
* \param symmetry_axis: Axis of symmetry, -1 to disable mirror decimate.
* \param symmetry_eps: Threshold when matching mirror verts.

2
source/blender/bmesh/tools/bmesh_decimate_unsubdivide.c
View File

@ -178,7 +178,7 @@ enum {
*/
/**
* \param tag_only so we can call this from an operator */
* \param tag_only: so we can call this from an operator */
void BM_mesh_decimate_unsubdivide_ex(BMesh *bm, const int iterations, const bool tag_only)
{
#ifdef USE_WALKER

4
source/blender/bmesh/tools/bmesh_edgenet.c
View File

@ -444,8 +444,8 @@ static LinkNode *bm_edgenet_path_calc_best(
* \note New faces currently don't have their normals calculated and are flipped randomly.
* The caller needs to flip faces correctly.
*
* \param bm The mesh to operate on.
* \param use_edge_tag Only fill tagged edges.
* \param bm: The mesh to operate on.
* \param use_edge_tag: Only fill tagged edges.
*/
void BM_mesh_edgenet(
BMesh *bm,

Some files were not shown because too many files have changed in this diff Show More