diff options
Diffstat (limited to 'source/blender/blenkernel/intern')
52 files changed, 175 insertions, 174 deletions
diff --git a/source/blender/blenkernel/intern/action.c b/source/blender/blenkernel/intern/action.c index 79230ad9e94..2810daf5019 100644 --- a/source/blender/blenkernel/intern/action.c +++ b/source/blender/blenkernel/intern/action.c @@ -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) { diff --git a/source/blender/blenkernel/intern/anim.c b/source/blender/blenkernel/intern/anim.c index c3b6041243d..1eea203f078 100644 --- a/source/blender/blenkernel/intern/anim.c +++ b/source/blender/blenkernel/intern/anim.c @@ -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) { diff --git a/source/blender/blenkernel/intern/anim_sys.c b/source/blender/blenkernel/intern/anim_sys.c index 8e8000f3ea0..9cdf94b3253 100644 --- a/source/blender/blenkernel/intern/anim_sys.c +++ b/source/blender/blenkernel/intern/anim_sys.c @@ -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) diff --git a/source/blender/blenkernel/intern/appdir.c b/source/blender/blenkernel/intern/appdir.c index 3643bf54e48..fc24ccc9fa0 100644 --- a/source/blender/blenkernel/intern/appdir.c +++ b/source/blender/blenkernel/intern/appdir.c @@ -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) { diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c index 0c63d66bb29..d1c1a47d137 100644 --- a/source/blender/blenkernel/intern/armature.c +++ b/source/blender/blenkernel/intern/armature.c @@ -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) { diff --git a/source/blender/blenkernel/intern/autoexec.c b/source/blender/blenkernel/intern/autoexec.c index bde06b02ae8..708820877d9 100644 --- a/source/blender/blenkernel/intern/autoexec.c +++ b/source/blender/blenkernel/intern/autoexec.c @@ -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) diff --git a/source/blender/blenkernel/intern/brush.c b/source/blender/blenkernel/intern/brush.c index f8fd3c56eb1..c2e5659a64f 100644 --- a/source/blender/blenkernel/intern/brush.c +++ b/source/blender/blenkernel/intern/brush.c @@ -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) { diff --git a/source/blender/blenkernel/intern/bvhutils.c b/source/blender/blenkernel/intern/bvhutils.c index 5c27b1b6207..83b18a57ba4 100644 --- a/source/blender/blenkernel/intern/bvhutils.c +++ b/source/blender/blenkernel/intern/bvhutils.c @@ -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, diff --git a/source/blender/blenkernel/intern/cachefile.c b/source/blender/blenkernel/intern/cachefile.c index c7d7a3a98eb..6fcfe468e98 100644 --- a/source/blender/blenkernel/intern/cachefile.c +++ b/source/blender/blenkernel/intern/cachefile.c @@ -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)) diff --git a/source/blender/blenkernel/intern/camera.c b/source/blender/blenkernel/intern/camera.c index ab9129e107a..f701538e0f9 100644 --- a/source/blender/blenkernel/intern/camera.c +++ b/source/blender/blenkernel/intern/camera.c @@ -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)) { diff --git a/source/blender/blenkernel/intern/collection.c b/source/blender/blenkernel/intern/collection.c index 763c0d51cb5..9b68c61e016 100644 --- a/source/blender/blenkernel/intern/collection.c +++ b/source/blender/blenkernel/intern/collection.c @@ -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) { diff --git a/source/blender/blenkernel/intern/colortools.c b/source/blender/blenkernel/intern/colortools.c index 60a7653cd1a..aad59e32187 100644 --- a/source/blender/blenkernel/intern/colortools.c +++ b/source/blender/blenkernel/intern/colortools.c @@ -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], diff --git a/source/blender/blenkernel/intern/context.c b/source/blender/blenkernel/intern/context.c index b3a26087dd0..96dd90cdf35 100644 --- a/source/blender/blenkernel/intern/context.c +++ b/source/blender/blenkernel/intern/context.c @@ -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) { diff --git a/source/blender/blenkernel/intern/curve.c b/source/blender/blenkernel/intern/curve.c index 527b950406b..900c5c27024 100644 --- a/source/blender/blenkernel/intern/curve.c +++ b/source/blender/blenkernel/intern/curve.c @@ -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, diff --git a/source/blender/blenkernel/intern/customdata.c b/source/blender/blenkernel/intern/customdata.c index b938dbb1d04..84864411360 100644 --- a/source/blender/blenkernel/intern/customdata.c +++ b/source/blender/blenkernel/intern/customdata.c @@ -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()). diff --git a/source/blender/blenkernel/intern/displist.c b/source/blender/blenkernel/intern/displist.c index 182c3204ccb..c985de94854 100644 --- a/source/blender/blenkernel/intern/displist.c +++ b/source/blender/blenkernel/intern/displist.c @@ -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) { diff --git a/source/blender/blenkernel/intern/gpencil.c b/source/blender/blenkernel/intern/gpencil.c index 2753a5adbaa..d0b7d433eb6 100644 --- a/source/blender/blenkernel/intern/gpencil.c +++ b/source/blender/blenkernel/intern/gpencil.c @@ -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) { diff --git a/source/blender/blenkernel/intern/idcode.c b/source/blender/blenkernel/intern/idcode.c index d97c00f8229..afc52cbc002 100644 --- a/source/blender/blenkernel/intern/idcode.c +++ b/source/blender/blenkernel/intern/idcode.c @@ -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) diff --git a/source/blender/blenkernel/intern/idprop.c b/source/blender/blenkernel/intern/idprop.c index 8cc40d4e74c..5ea9f9b20f9 100644 --- a/source/blender/blenkernel/intern/idprop.c +++ b/source/blender/blenkernel/intern/idprop.c @@ -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) diff --git a/source/blender/blenkernel/intern/image.c b/source/blender/blenkernel/intern/image.c index f8e28f680c1..3efe288dcf4 100644 --- a/source/blender/blenkernel/intern/image.c +++ b/source/blender/blenkernel/intern/image.c @@ -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) { diff --git a/source/blender/blenkernel/intern/key.c b/source/blender/blenkernel/intern/key.c index a01d78f5c36..dce748e3ea3 100644 --- a/source/blender/blenkernel/intern/key.c +++ b/source/blender/blenkernel/intern/key.c @@ -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) diff --git a/source/blender/blenkernel/intern/lamp.c b/source/blender/blenkernel/intern/lamp.c index 29f62519350..a6ec44f524c 100644 --- a/source/blender/blenkernel/intern/lamp.c +++ b/source/blender/blenkernel/intern/lamp.c @@ -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) { diff --git a/source/blender/blenkernel/intern/lattice.c b/source/blender/blenkernel/intern/lattice.c index 0fa675639ea..02cec8b692e 100644 --- a/source/blender/blenkernel/intern/lattice.c +++ b/source/blender/blenkernel/intern/lattice.c @@ -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) { diff --git a/source/blender/blenkernel/intern/layer.c b/source/blender/blenkernel/intern/layer.c index bee915567bd..3fedd380f72 100644 --- a/source/blender/blenkernel/intern/layer.c +++ b/source/blender/blenkernel/intern/layer.c @@ -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), diff --git a/source/blender/blenkernel/intern/library.c b/source/blender/blenkernel/intern/library.c index b77b2f18b77..55322dbc333 100644 --- a/source/blender/blenkernel/intern/library.c +++ b/source/blender/blenkernel/intern/library.c @@ -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) { diff --git a/source/blender/blenkernel/intern/library_query.c b/source/blender/blenkernel/intern/library_query.c index a06be37f41d..9428e1508a4 100644 --- a/source/blender/blenkernel/intern/library_query.c +++ b/source/blender/blenkernel/intern/library_query.c @@ -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) diff --git a/source/blender/blenkernel/intern/lightprobe.c b/source/blender/blenkernel/intern/lightprobe.c index 4cb2b450afe..5017827ea9c 100644 --- a/source/blender/blenkernel/intern/lightprobe.c +++ b/source/blender/blenkernel/intern/lightprobe.c @@ -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)) diff --git a/source/blender/blenkernel/intern/linestyle.c b/source/blender/blenkernel/intern/linestyle.c index 5757ae7480b..fdf5ef5f0c1 100644 --- a/source/blender/blenkernel/intern/linestyle.c +++ b/source/blender/blenkernel/intern/linestyle.c @@ -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) diff --git a/source/blender/blenkernel/intern/main.c b/source/blender/blenkernel/intern/main.c index c063af48186..e40a1eb9ba8 100644 --- a/source/blender/blenkernel/intern/main.c +++ b/source/blender/blenkernel/intern/main.c @@ -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) diff --git a/source/blender/blenkernel/intern/mask.c b/source/blender/blenkernel/intern/mask.c index 97058467fd9..3f6eaffa552 100644 --- a/source/blender/blenkernel/intern/mask.c +++ b/source/blender/blenkernel/intern/mask.c @@ -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)) { diff --git a/source/blender/blenkernel/intern/material.c b/source/blender/blenkernel/intern/material.c index 166408336ac..81c220045ba 100644 --- a/source/blender/blenkernel/intern/material.c +++ b/source/blender/blenkernel/intern/material.c @@ -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) { diff --git a/source/blender/blenkernel/intern/mball.c b/source/blender/blenkernel/intern/mball.c index 63adcfc3cae..cff425dbd1b 100644 --- a/source/blender/blenkernel/intern/mball.c +++ b/source/blender/blenkernel/intern/mball.c @@ -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)) { diff --git a/source/blender/blenkernel/intern/mesh.c b/source/blender/blenkernel/intern/mesh.c index 608c9780beb..635032d15a4 100644 --- a/source/blender/blenkernel/intern/mesh.c +++ b/source/blender/blenkernel/intern/mesh.c @@ -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) diff --git a/source/blender/blenkernel/intern/mesh_evaluate.c b/source/blender/blenkernel/intern/mesh_evaluate.c index fd117734aaf..b6ba4a15e40 100644 --- a/source/blender/blenkernel/intern/mesh_evaluate.c +++ b/source/blender/blenkernel/intern/mesh_evaluate.c @@ -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, diff --git a/source/blender/blenkernel/intern/mesh_mapping.c b/source/blender/blenkernel/intern/mesh_mapping.c index 2d82a5102b0..d8726644f48 100644 --- a/source/blender/blenkernel/intern/mesh_mapping.c +++ b/source/blender/blenkernel/intern/mesh_mapping.c @@ -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. diff --git a/source/blender/blenkernel/intern/mesh_merge.c b/source/blender/blenkernel/intern/mesh_merge.c index 5324c397ebf..b88fd5d2a21 100644 --- a/source/blender/blenkernel/intern/mesh_merge.c +++ b/source/blender/blenkernel/intern/mesh_merge.c @@ -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 diff --git a/source/blender/blenkernel/intern/mesh_validate.c b/source/blender/blenkernel/intern/mesh_validate.c index 8ecb47c8591..f0115967d84 100644 --- a/source/blender/blenkernel/intern/mesh_validate.c +++ b/source/blender/blenkernel/intern/mesh_validate.c @@ -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) diff --git a/source/blender/blenkernel/intern/modifier.c b/source/blender/blenkernel/intern/modifier.c index d67a3080819..f7a2efbe618 100644 --- a/source/blender/blenkernel/intern/modifier.c +++ b/source/blender/blenkernel/intern/modifier.c @@ -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) { diff --git a/source/blender/blenkernel/intern/movieclip.c b/source/blender/blenkernel/intern/movieclip.c index 0117b36a16e..7d279342093 100644 --- a/source/blender/blenkernel/intern/movieclip.c +++ b/source/blender/blenkernel/intern/movieclip.c @@ -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) { diff --git a/source/blender/blenkernel/intern/nla.c b/source/blender/blenkernel/intern/nla.c index 76671e0775d..bbbb7e10e3f 100644 --- a/source/blender/blenkernel/intern/nla.c +++ b/source/blender/blenkernel/intern/nla.c @@ -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) { diff --git a/source/blender/blenkernel/intern/node.c b/source/blender/blenkernel/intern/node.c index 04cc58f373f..9b06b49a5d9 100644 --- a/source/blender/blenkernel/intern/node.c +++ b/source/blender/blenkernel/intern/node.c @@ -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) { diff --git a/source/blender/blenkernel/intern/object.c b/source/blender/blenkernel/intern/object.c index af815175302..cb5cb96acd3 100644 --- a/source/blender/blenkernel/intern/object.c +++ b/source/blender/blenkernel/intern/object.c @@ -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) diff --git a/source/blender/blenkernel/intern/object_deform.c b/source/blender/blenkernel/intern/object_deform.c index 70569bfd51b..2e751668a40 100644 --- a/source/blender/blenkernel/intern/object_deform.c +++ b/source/blender/blenkernel/intern/object_deform.c @@ -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) { diff --git a/source/blender/blenkernel/intern/paint.c b/source/blender/blenkernel/intern/paint.c index e7c10f070dc..08c6413efa2 100644 --- a/source/blender/blenkernel/intern/paint.c +++ b/source/blender/blenkernel/intern/paint.c @@ -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, diff --git a/source/blender/blenkernel/intern/particle.c b/source/blender/blenkernel/intern/particle.c index d51b39514f4..7f3bae9d178 100644 --- a/source/blender/blenkernel/intern/particle.c +++ b/source/blender/blenkernel/intern/particle.c @@ -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)) diff --git a/source/blender/blenkernel/intern/rigidbody.c b/source/blender/blenkernel/intern/rigidbody.c index 22fb863d829..aa5051e25cd 100644 --- a/source/blender/blenkernel/intern/rigidbody.c +++ b/source/blender/blenkernel/intern/rigidbody.c @@ -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) { diff --git a/source/blender/blenkernel/intern/scene.c b/source/blender/blenkernel/intern/scene.c index 36b75d993a9..20eab1369d1 100644 --- a/source/blender/blenkernel/intern/scene.c +++ b/source/blender/blenkernel/intern/scene.c @@ -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) { diff --git a/source/blender/blenkernel/intern/sound.c b/source/blender/blenkernel/intern/sound.c index 5135362bd69..44aa69e3c8e 100644 --- a/source/blender/blenkernel/intern/sound.c +++ b/source/blender/blenkernel/intern/sound.c @@ -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)) { diff --git a/source/blender/blenkernel/intern/speaker.c b/source/blender/blenkernel/intern/speaker.c index 1d2e12f34ac..7c92844ac2e 100644 --- a/source/blender/blenkernel/intern/speaker.c +++ b/source/blender/blenkernel/intern/speaker.c @@ -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)) { diff --git a/source/blender/blenkernel/intern/text.c b/source/blender/blenkernel/intern/text.c index 3b9edaa4c18..39388ebeb4f 100644 --- a/source/blender/blenkernel/intern/text.c +++ b/source/blender/blenkernel/intern/text.c @@ -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)) { diff --git a/source/blender/blenkernel/intern/texture.c b/source/blender/blenkernel/intern/texture.c index bd527ed8a44..cdcb51f8e72 100644 --- a/source/blender/blenkernel/intern/texture.c +++ b/source/blender/blenkernel/intern/texture.c @@ -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) { diff --git a/source/blender/blenkernel/intern/world.c b/source/blender/blenkernel/intern/world.c index e7a4167087b..bab1b297637 100644 --- a/source/blender/blenkernel/intern/world.c +++ b/source/blender/blenkernel/intern/world.c @@ -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) { |