diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2018-12-12 04:50:58 +0300 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2018-12-12 04:50:58 +0300 |
| commit | e757c4a3bec8b0e8d198531a28327332af00a9ba (patch) | |
| tree | 4707fd51cffdbe932123a29bbcfe4528fc9c2b55 | |
| parent | ba8d6ca3dd92eed5d679caa28f5446cd07b8a112 (diff) | |
Cleanup: use colon separator after parameter
Helps separate variable names from descriptive text.
Was already used in some parts of the code,
double space and dashes were used elsewhere.
190 files changed, 1173 insertions, 1172 deletions
diff --git a/source/blender/alembic/intern/alembic_capi.cc b/source/blender/alembic/intern/alembic_capi.cc index b7c1f98bfb0..4b41277f0df 100644 --- a/source/blender/alembic/intern/alembic_capi.cc +++ b/source/blender/alembic/intern/alembic_capi.cc @@ -395,11 +395,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. diff --git a/source/blender/blenkernel/BKE_idcode.h b/source/blender/blenkernel/BKE_idcode.h index 964a49435f1..2400d02a21d 100644 --- a/source/blender/blenkernel/BKE_idcode.h +++ b/source/blender/blenkernel/BKE_idcode.h @@ -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); diff --git a/source/blender/blenkernel/intern/action.c b/source/blender/blenkernel/intern/action.c index 7612e9a3fdb..bbd7511842f 100644 --- a/source/blender/blenkernel/intern/action.c +++ b/source/blender/blenkernel/intern/action.c @@ -126,7 +126,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)) { @@ -531,7 +531,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 d5f269b82a8..45e1de49092 100644 --- a/source/blender/blenkernel/intern/anim.c +++ b/source/blender/blenkernel/intern/anim.c @@ -129,9 +129,9 @@ void animviz_free_motionpath(bMotionPath *mpath) * 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 500ece2a735..d0262579663 100644 --- a/source/blender/blenkernel/intern/anim_sys.c +++ b/source/blender/blenkernel/intern/anim_sys.c @@ -409,8 +409,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[]) @@ -582,9 +582,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 8d6c34222d7..ecd37c8dab5 100644 --- a/source/blender/blenkernel/intern/appdir.c +++ b/source/blender/blenkernel/intern/appdir.c @@ -182,10 +182,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( @@ -273,10 +273,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( @@ -314,10 +314,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( @@ -542,9 +542,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) { @@ -744,10 +744,10 @@ bool BKE_appdir_app_template_id_search(const char *app_template, char *path, siz * * 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 0f9c79c5e3e..65b6b2fe3b2 100644 --- a/source/blender/blenkernel/intern/armature.c +++ b/source/blender/blenkernel/intern/armature.c @@ -181,7 +181,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) { 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 5b76d75f261..e59c0231d84 100644 --- a/source/blender/blenkernel/intern/brush.c +++ b/source/blender/blenkernel/intern/brush.c @@ -181,7 +181,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 151d697d891..e615fdfccbc 100644 --- a/source/blender/blenkernel/intern/bvhutils.c +++ b/source/blender/blenkernel/intern/bvhutils.c @@ -499,9 +499,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, @@ -651,9 +651,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 5f7759c7b55..8f5a08d66a9 100644 --- a/source/blender/blenkernel/intern/cachefile.c +++ b/source/blender/blenkernel/intern/cachefile.c @@ -105,7 +105,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 3e6e88c5f44..5dd60e8dd73 100644 --- a/source/blender/blenkernel/intern/camera.c +++ b/source/blender/blenkernel/intern/camera.c @@ -98,7 +98,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 *UNUSED(cam_dst), const Camera *UNUSED(cam_src), const int UNUSED(flag)) { diff --git a/source/blender/blenkernel/intern/cdderivedmesh.c b/source/blender/blenkernel/intern/cdderivedmesh.c index ed2b8cddc14..16d131330cd 100644 --- a/source/blender/blenkernel/intern/cdderivedmesh.c +++ b/source/blender/blenkernel/intern/cdderivedmesh.c @@ -2947,15 +2947,15 @@ static bool poly_gset_compare_fn(const void *k1, const void *k2) * * This frees dm, and returns a new one. * - * \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 'dm->numVertData' * \warning \a vtergatmap 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. * - #CDDM_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/colortools.c b/source/blender/blenkernel/intern/colortools.c index ff4795afe87..459c97d1b01 100644 --- a/source/blender/blenkernel/intern/colortools.c +++ b/source/blender/blenkernel/intern/colortools.c @@ -925,8 +925,8 @@ void curvemapping_evaluateRGBF(const CurveMapping *cumap, float vecout[3], const * * 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], const float black[3], const float bwmul[3]) diff --git a/source/blender/blenkernel/intern/context.c b/source/blender/blenkernel/intern/context.c index c9468c7d95c..bdaa2e7fbfa 100644 --- a/source/blender/blenkernel/intern/context.c +++ b/source/blender/blenkernel/intern/context.c @@ -467,10 +467,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 b395df49061..7c27b9bf9f5 100644 --- a/source/blender/blenkernel/intern/curve.c +++ b/source/blender/blenkernel/intern/curve.c @@ -196,7 +196,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) { @@ -1356,9 +1356,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 8fa117dfce1..1016568f7ec 100644 --- a/source/blender/blenkernel/intern/customdata.c +++ b/source/blender/blenkernel/intern/customdata.c @@ -2321,7 +2321,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) { @@ -3191,7 +3191,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 */ @@ -3303,11 +3303,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 dea1a3718dd..2e10697f315 100644 --- a/source/blender/blenkernel/intern/displist.c +++ b/source/blender/blenkernel/intern/displist.c @@ -451,9 +451,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 a0d759118ec..a88794fea64 100644 --- a/source/blender/blenkernel/intern/gpencil.c +++ b/source/blender/blenkernel/intern/gpencil.c @@ -759,7 +759,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(Main *UNUSED(bmain), bGPdata *gpd_dst, const bGPdata *gpd_src, const int UNUSED(flag)) { diff --git a/source/blender/blenkernel/intern/group.c b/source/blender/blenkernel/intern/group.c index 62f608f8565..3f4c62069f8 100644 --- a/source/blender/blenkernel/intern/group.c +++ b/source/blender/blenkernel/intern/group.c @@ -95,7 +95,7 @@ Group *BKE_group_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_group_copy_data(Main *UNUSED(bmain), Group *group_dst, const Group *group_src, const int flag) { diff --git a/source/blender/blenkernel/intern/idcode.c b/source/blender/blenkernel/intern/idcode.c index d995dce1259..68acd9e1234 100644 --- a/source/blender/blenkernel/intern/idcode.c +++ b/source/blender/blenkernel/intern/idcode.c @@ -163,7 +163,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) @@ -341,7 +341,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 7a526d31567..6fe0c9b3cc6 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) @@ -810,7 +810,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 1d209dec935..2da33d4e1bc 100644 --- a/source/blender/blenkernel/intern/image.c +++ b/source/blender/blenkernel/intern/image.c @@ -452,7 +452,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 4689575655e..ee11b67ca67 100644 --- a/source/blender/blenkernel/intern/key.c +++ b/source/blender/blenkernel/intern/key.c @@ -160,7 +160,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)) { @@ -1492,9 +1492,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) { @@ -1800,11 +1800,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, @@ -2049,7 +2049,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 84a8e11bdc8..c1a781d4936 100644 --- a/source/blender/blenkernel/intern/lamp.c +++ b/source/blender/blenkernel/intern/lamp.c @@ -121,7 +121,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 1e99712f47a..64c1d3ab02f 100644 --- a/source/blender/blenkernel/intern/lattice.c +++ b/source/blender/blenkernel/intern/lattice.c @@ -284,7 +284,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/library.c b/source/blender/blenkernel/intern/library.c index a6cee54d81f..4d526ad8c77 100644 --- a/source/blender/blenkernel/intern/library.c +++ b/source/blender/blenkernel/intern/library.c @@ -370,7 +370,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. */ @@ -515,11 +515,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! */ @@ -1529,8 +1529,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) @@ -1560,8 +1560,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) @@ -1948,10 +1948,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... diff --git a/source/blender/blenkernel/intern/library_query.c b/source/blender/blenkernel/intern/library_query.c index f5367f6f8b3..8a646484e2c 100644 --- a/source/blender/blenkernel/intern/library_query.c +++ b/source/blender/blenkernel/intern/library_query.c @@ -1182,8 +1182,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) @@ -1319,7 +1319,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/linestyle.c b/source/blender/blenkernel/intern/linestyle.c index e00884c8a9d..3c1d591d3f4 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/mask.c b/source/blender/blenkernel/intern/mask.c index b5742dbdbb7..2a84109c1e0 100644 --- a/source/blender/blenkernel/intern/mask.c +++ b/source/blender/blenkernel/intern/mask.c @@ -849,7 +849,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 3414d08b8e7..5c8ac0a81ce 100644 --- a/source/blender/blenkernel/intern/material.c +++ b/source/blender/blenkernel/intern/material.c @@ -225,7 +225,7 @@ Material *BKE_material_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_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 9e926e5ef53..84d9cce0d2f 100644 --- a/source/blender/blenkernel/intern/mball.c +++ b/source/blender/blenkernel/intern/mball.c @@ -109,7 +109,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 5758e00a28d..63477d859e8 100644 --- a/source/blender/blenkernel/intern/mesh.c +++ b/source/blender/blenkernel/intern/mesh.c @@ -491,7 +491,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) { @@ -1340,7 +1340,7 @@ void BKE_mesh_mselect_active_set(Mesh *me, int index, int type) /** * 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 e3b1f20e583..c9119948aa3 100644 --- a/source/blender/blenkernel/intern/mesh_evaluate.c +++ b/source/blender/blenkernel/intern/mesh_evaluate.c @@ -2627,7 +2627,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. */ @@ -3461,9 +3461,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, @@ -3728,11 +3728,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_validate.c b/source/blender/blenkernel/intern/mesh_validate.c index 82b3edb5b49..09a798f5468 100644 --- a/source/blender/blenkernel/intern/mesh_validate.c +++ b/source/blender/blenkernel/intern/mesh_validate.c @@ -1446,8 +1446,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) { diff --git a/source/blender/blenkernel/intern/modifier.c b/source/blender/blenkernel/intern/modifier.c index 723b4a5aa97..b5171258e55 100644 --- a/source/blender/blenkernel/intern/modifier.c +++ b/source/blender/blenkernel/intern/modifier.c @@ -466,7 +466,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(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 a11b0c62aa8..907ae2f35e2 100644 --- a/source/blender/blenkernel/intern/movieclip.c +++ b/source/blender/blenkernel/intern/movieclip.c @@ -1513,7 +1513,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 2f0af028abd..3a9488df155 100644 --- a/source/blender/blenkernel/intern/nla.c +++ b/source/blender/blenkernel/intern/nla.c @@ -161,7 +161,7 @@ void BKE_nla_tracks_free(ListBase *tracks) /** * Copy NLA strip * - * \param use_same_action When true, the existing action is used (instead of being duplicated) + * \param use_same_action: When true, the existing action is used (instead of being duplicated) */ NlaStrip *BKE_nlastrip_copy(Main *bmain, NlaStrip *strip, const bool use_same_action) { diff --git a/source/blender/blenkernel/intern/node.c b/source/blender/blenkernel/intern/node.c index 2946fb29863..f89163d6339 100644 --- a/source/blender/blenkernel/intern/node.c +++ b/source/blender/blenkernel/intern/node.c @@ -847,7 +847,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( @@ -1249,7 +1249,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 5a9ecaa7232..66ea5481af0 100644 --- a/source/blender/blenkernel/intern/object.c +++ b/source/blender/blenkernel/intern/object.c @@ -1110,7 +1110,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 *UNUSED(bmain), Object *ob_dst, const Object *ob_src, const int flag) { @@ -2014,7 +2014,7 @@ void BKE_object_get_parent_matrix(Scene *scene, Object *ob, Object *par, float p } /** - * \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(Scene *scene, Object *ob, Object *par, float obmat[4][4], float slowmat[4][4], float r_originmat[3][3], const bool set_origin) @@ -3424,8 +3424,8 @@ void BKE_object_groups_clear(Main *bmain, Scene *scene, Base *base, Object *obje * * \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 47f86c28dfc..43e84dc2150 100644 --- a/source/blender/blenkernel/intern/object_deform.c +++ b/source/blender/blenkernel/intern/object_deform.c @@ -68,7 +68,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 dd5d801d2ac..76f18383fe8 100644 --- a/source/blender/blenkernel/intern/paint.c +++ b/source/blender/blenkernel/intern/paint.c @@ -302,7 +302,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)) { @@ -391,7 +391,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)) { @@ -853,7 +853,7 @@ static bool sculpt_modifiers_active(Scene *scene, Sculpt *sd, Object *ob) } /** - * \param need_mask So the DerivedMesh thats returned has mask data + * \param need_mask: So the DerivedMesh thats returned has mask data */ void BKE_sculpt_update_mesh_elements(Scene *scene, Sculpt *sd, Object *ob, bool need_pmap, bool need_mask) diff --git a/source/blender/blenkernel/intern/particle.c b/source/blender/blenkernel/intern/particle.c index e24602050ef..e2a69c38133 100644 --- a/source/blender/blenkernel/intern/particle.c +++ b/source/blender/blenkernel/intern/particle.c @@ -1433,11 +1433,11 @@ static void psys_origspace_to_w(OrigSpaceFace *osface, int quad, const float w[4 * Find the final derived mesh tessface for a particle, from its original tessface index. * This is slow and can be optimized but only for many lookups. * - * \param dm_final final DM, it may not have the same topology as original mesh. - * \param dm_deformed deformed-only DM, it has the exact same topology as original mesh. - * \param findex_orig the input tessface index. - * \param fw face weights (position of the particle inside the \a findex_orig tessface). - * \param poly_nodes may be NULL, otherwise an array of linked list, one for each final DM polygon, containing all + * \param dm_final: final DM, it may not have the same topology as original mesh. + * \param dm_deformed: deformed-only DM, it has the exact same topology as original mesh. + * \param findex_orig: the input tessface index. + * \param fw: face weights (position of the particle inside the \a findex_orig tessface). + * \param poly_nodes: may be NULL, otherwise an array of linked list, one for each final DM polygon, containing all * its tessfaces indices. * \return the DM tessface index. */ @@ -3374,7 +3374,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 f485233fe3c..63b1a536d77 100644 --- a/source/blender/blenkernel/intern/rigidbody.c +++ b/source/blender/blenkernel/intern/rigidbody.c @@ -638,7 +638,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) { @@ -765,7 +765,7 @@ static void rigidbody_constraint_set_limits(RigidBodyCon *rbc, void (*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) { @@ -1137,7 +1137,7 @@ RigidBodyCon *BKE_rigidbody_create_constraint(Scene *scene, Object *ob, short ty /* 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) { @@ -1338,7 +1338,7 @@ static void rigidbody_update_sim_ob(Scene *scene, RigidBodyWorld *rbw, Object *o /** * Updates and validates world, bodies and shapes. * - * \param rebuild Rebuild entire simulation + * \param rebuild: Rebuild entire simulation */ static void rigidbody_update_simulation(Scene *scene, RigidBodyWorld *rbw, bool rebuild) { diff --git a/source/blender/blenkernel/intern/scene.c b/source/blender/blenkernel/intern/scene.c index 3947ca157c0..d038a267308 100644 --- a/source/blender/blenkernel/intern/scene.c +++ b/source/blender/blenkernel/intern/scene.c @@ -226,7 +226,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 d21055ada6a..9a0317a6648 100644 --- a/source/blender/blenkernel/intern/sound.c +++ b/source/blender/blenkernel/intern/sound.c @@ -161,7 +161,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 63b9f838632..dbbdf1d5f65 100644 --- a/source/blender/blenkernel/intern/text.c +++ b/source/blender/blenkernel/intern/text.c @@ -476,7 +476,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 bd6199d91b4..f21172b937d 100644 --- a/source/blender/blenkernel/intern/texture.c +++ b/source/blender/blenkernel/intern/texture.c @@ -494,7 +494,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 a44d717bbdd..19bc7bff8d1 100644 --- a/source/blender/blenkernel/intern/world.c +++ b/source/blender/blenkernel/intern/world.c @@ -124,7 +124,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) { diff --git a/source/blender/blenlib/BLI_astar.h b/source/blender/blenlib/BLI_astar.h index 5e9434a1d56..99e0dcd1a27 100644 --- a/source/blender/blenlib/BLI_astar.h +++ b/source/blender/blenlib/BLI_astar.h @@ -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); diff --git a/source/blender/blenlib/PIL_time.h b/source/blender/blenlib/PIL_time.h index 088b275738e..077e48772e5 100644 --- a/source/blender/blenlib/PIL_time.h +++ b/source/blender/blenlib/PIL_time.h @@ -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); diff --git a/source/blender/blenlib/intern/BLI_dynstr.c b/source/blender/blenlib/intern/BLI_dynstr.c index d3fc8ae0ed5..c1f9906cc12 100644 --- a/source/blender/blenlib/intern/BLI_dynstr.c +++ b/source/blender/blenlib/intern/BLI_dynstr.c @@ -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) { diff --git a/source/blender/blenlib/intern/BLI_ghash.c b/source/blender/blenlib/intern/BLI_ghash.c index ec75c140159..edc6286118d 100644 --- a/source/blender/blenlib/intern/BLI_ghash.c +++ b/source/blender/blenlib/intern/BLI_ghash.c @@ -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) { @@ -1113,7 +1113,7 @@ void BLI_ghashIterator_free(GHashIterator *ghi) /** * Retrieve the key from an iterator. * - * \param ghi The iterator. + * \param ghi: The iterator. * \return The key at the current index, or NULL if the * iterator is done. */ @@ -1125,7 +1125,7 @@ void *BLI_ghashIterator_getKey(GHashIterator *ghi) /** * Retrieve the value from an iterator. * - * \param ghi The iterator. + * \param ghi: The iterator. * \return The value at the current index, or NULL if the * iterator is done. */ @@ -1137,7 +1137,7 @@ void *BLI_ghashIterator_getValue(GHashIterator *ghi) /** * Retrieve the value from an iterator. * - * \param ghi The iterator. + * \param ghi: The iterator. * \return The value at the current index, or NULL if the * iterator is done. */ @@ -1150,7 +1150,7 @@ void **BLI_ghashIterator_getValue_p(GHashIterator *ghi) * Determine if an iterator is done (has reached the end of * the hash table). * - * \param ghi The iterator. + * \param ghi: The iterator. * \return True if done, False otherwise. */ bool BLI_ghashIterator_done(GHashIterator *ghi) diff --git a/source/blender/blenlib/intern/BLI_kdtree.c b/source/blender/blenlib/intern/BLI_kdtree.c index 80a2957d907..9265c8ee562 100644 --- a/source/blender/blenlib/intern/BLI_kdtree.c +++ b/source/blender/blenlib/intern/BLI_kdtree.c @@ -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], diff --git a/source/blender/blenlib/intern/BLI_mempool.c b/source/blender/blenlib/intern/BLI_mempool.c index 3a65e6c42ca..b2cd7e58696 100644 --- a/source/blender/blenlib/intern/BLI_mempool.c +++ b/source/blender/blenlib/intern/BLI_mempool.c @@ -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) { diff --git a/source/blender/blenlib/intern/astar.c b/source/blender/blenlib/intern/astar.c index 86c1faad096..0555d3e3df5 100644 --- a/source/blender/blenlib/intern/astar.c +++ b/source/blender/blenlib/intern/astar.c @@ -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. */ diff --git a/source/blender/blenlib/intern/convexhull_2d.c b/source/blender/blenlib/intern/convexhull_2d.c index 38928dbbaa0..c4b408ba40f 100644 --- a/source/blender/blenlib/intern/convexhull_2d.c +++ b/source/blender/blenlib/intern/convexhull_2d.c @@ -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) { diff --git a/source/blender/blenlib/intern/edgehash.c b/source/blender/blenlib/intern/edgehash.c index 7074a776aaf..91b5f6486c5 100644 --- a/source/blender/blenlib/intern/edgehash.c +++ b/source/blender/blenlib/intern/edgehash.c @@ -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) { diff --git a/source/blender/blenlib/intern/fileops.c b/source/blender/blenlib/intern/fileops.c index 0b57a727452..82ddc5a63f5 100644 --- a/source/blender/blenlib/intern/fileops.c +++ b/source/blender/blenlib/intern/fileops.c @@ -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, diff --git a/source/blender/blenlib/intern/freetypefont.c b/source/blender/blenlib/intern/freetypefont.c index b493b97863c..309bffeca00 100644 --- a/source/blender/blenlib/intern/freetypefont.c +++ b/source/blender/blenlib/intern/freetypefont.c @@ -453,7 +453,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. */ diff --git a/source/blender/blenlib/intern/gsqueue.c b/source/blender/blenlib/intern/gsqueue.c index 29b882d0e99..4100a390e6f 100644 --- a/source/blender/blenlib/intern/gsqueue.c +++ b/source/blender/blenlib/intern/gsqueue.c @@ -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) diff --git a/source/blender/blenlib/intern/listbase.c b/source/blender/blenlib/intern/listbase.c index 568448327bd..cec2fdd5faf 100644 --- a/source/blender/blenlib/intern/listbase.c +++ b/source/blender/blenlib/intern/listbase.c @@ -795,7 +795,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) { @@ -811,7 +811,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) { diff --git a/source/blender/blenlib/intern/math_base_inline.c b/source/blender/blenlib/intern/math_base_inline.c index 0f282805e71..647ab8aa478 100644 --- a/source/blender/blenlib/intern/math_base_inline.c +++ b/source/blender/blenlib/intern/math_base_inline.c @@ -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/ */ diff --git a/source/blender/blenlib/intern/math_geom.c b/source/blender/blenlib/intern/math_geom.c index dca9d4204c3..eb6abfe2c32 100644 --- a/source/blender/blenlib/intern/math_geom.c +++ b/source/blender/blenlib/intern/math_geom.c @@ -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). @@ -1852,11 +1852,11 @@ bool isect_point_planes_v3(float (*planes)[4], int totplane, const float p[3]) /** * 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. */ @@ -2929,8 +2929,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]) { diff --git a/source/blender/blenlib/intern/math_geom_inline.c b/source/blender/blenlib/intern/math_geom_inline.c index 68a2e68db4f..e0499e0eaa8 100644 --- a/source/blender/blenlib/intern/math_geom_inline.c +++ b/source/blender/blenlib/intern/math_geom_inline.c @@ -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) { diff --git a/source/blender/blenlib/intern/math_rotation.c b/source/blender/blenlib/intern/math_rotation.c index f0c830d33c6..726ad5ea7fe 100644 --- a/source/blender/blenlib/intern/math_rotation.c +++ b/source/blender/blenlib/intern/math_rotation.c @@ -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) diff --git a/source/blender/blenlib/intern/math_solvers.c b/source/blender/blenlib/intern/math_solvers.c index e3174d8340a..1c4323c871a 100644 --- a/source/blender/blenlib/intern/math_solvers.c +++ b/source/blender/blenlib/intern/math_solvers.c @@ -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) diff --git a/source/blender/blenlib/intern/math_statistics.c b/source/blender/blenlib/intern/math_statistics.c index 3a19f1d3603..bc565fef6c6 100644 --- a/source/blender/blenlib/intern/math_statistics.c +++ b/source/blender/blenlib/intern/math_statistics.c @@ -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). */ diff --git a/source/blender/blenlib/intern/path_util.c b/source/blender/blenlib/intern/path_util.c index 84c932db1c7..04c711f718c 100644 --- a/source/blender/blenlib/intern/path_util.c +++ b/source/blender/blenlib/intern/path_util.c @@ -80,10 +80,10 @@ static bool BLI_path_is_abs(const char *name); * Looks for a sequence of decimal digits in string, preceding any filename extension, * returning the integer value if found, or 0 if not. * - * \param string String to scan. - * \param head Optional area to return copy of part of string prior to digits, or before dot if no digits. - * \param tail Optional area to return copy of part of string following digits, or from dot if no digits. - * \param numlen Optional to return number of digits found. + * \param string: String to scan. + * \param head: Optional area to return copy of part of string prior to digits, or before dot if no digits. + * \param tail: Optional area to return copy of part of string following digits, or from dot if no digits. + * \param numlen: Optional to return number of digits found. */ int BLI_stringdec(const char *string, char *head, char *tail, ushort *r_num_len) { @@ -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) @@ -1282,8 +1282,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) { diff --git a/source/blender/blenlib/intern/string.c b/source/blender/blenlib/intern/string.c index c1696a912ba..66b9cee50c3 100644 --- a/source/blender/blenlib/intern/string.c +++ b/source/blender/blenlib/intern/string.c @@ -54,8 +54,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) @@ -71,7 +71,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) @@ -81,8 +81,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) @@ -105,9 +105,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 */ @@ -128,10 +128,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) @@ -180,9 +180,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). */ @@ -412,9 +412,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) @@ -783,8 +783,8 @@ void BLI_str_toupper_ascii(char *str, const size_t len) * 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) @@ -810,9 +810,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) @@ -831,8 +831,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) @@ -867,8 +867,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) @@ -880,10 +880,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) @@ -894,10 +894,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) @@ -908,12 +908,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( @@ -964,8 +964,8 @@ size_t BLI_str_partition_ex( * 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) @@ -1000,9 +1000,9 @@ size_t BLI_str_format_int_grouped(char dst[16], int 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) { diff --git a/source/blender/blenlib/intern/string_utf8.c b/source/blender/blenlib/intern/string_utf8.c index b41f7d0be66..1e2a9629e0f 100644 --- a/source/blender/blenlib/intern/string_utf8.c +++ b/source/blender/blenlib/intern/string_utf8.c @@ -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 * diff --git a/source/blender/blenlib/intern/string_utils.c b/source/blender/blenlib/intern/string_utils.c index 296086ed652..ca7894cf115 100644 --- a/source/blender/blenlib/intern/string_utils.c +++ b/source/blender/blenlib/intern/string_utils.c @@ -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) { diff --git a/source/blender/blenlib/intern/task.c b/source/blender/blenlib/intern/task.c index f71c0d7a748..c05634d3062 100644 --- a/source/blender/blenlib/intern/task.c +++ b/source/blender/blenlib/intern/task.c @@ -1249,10 +1249,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... diff --git a/source/blender/blenlib/intern/timecode.c b/source/blender/blenlib/intern/timecode.c index f59c493206f..ab7766d2cd6 100644 --- a/source/blender/blenlib/intern/timecode.c +++ b/source/blender/blenlib/intern/timecode.c @@ -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. diff --git a/source/blender/blenloader/intern/readblenentry.c b/source/blender/blenloader/intern/readblenentry.c index 0d8f056e9c4..f4c0186e750 100644 --- a/source/blender/blenloader/intern/readblenentry.c +++ b/source/blender/blenloader/intern/readblenentry.c @@ -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, @@ -463,7 +463,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) { diff --git a/source/blender/blenloader/intern/readfile.c b/source/blender/blenloader/intern/readfile.c index 8d89620cdec..27bdc1b5d00 100644 --- a/source/blender/blenloader/intern/readfile.c +++ b/source/blender/blenloader/intern/readfile.c @@ -1353,7 +1353,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) @@ -1365,11 +1365,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) @@ -1431,7 +1431,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). */ @@ -9863,7 +9863,7 @@ static void expand_gpencil(FileData *fd, Main *mainvar, bGPdata *gpd) /** * 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) { @@ -9874,8 +9874,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) { @@ -10244,10 +10244,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) @@ -10260,13 +10260,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/group 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/groups (if NULL, no instantiation is done). - * \param v3d The active View3D (only to define active layers for instantiated objects & groups, 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/groups (if NULL, no instantiation is done). + * \param v3d: The active View3D (only to define active layers for instantiated objects & groups, can be NULL). * \return the linked ID when found. */ ID *BLO_library_link_named_part_ex( @@ -10350,9 +10350,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) @@ -10469,11 +10469,11 @@ static void library_link_end(Main *mainl, FileData **fd, const short flag, Scene * Optionally instance the indirect object/group 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 scene The scene in which to instantiate objects/groups (if NULL, no instantiation is done). - * \param v3d The active View3D (only to define active layers for instantiated objects & groups, can be NULL). + * \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 scene: The scene in which to instantiate objects/groups (if NULL, no instantiation is done). + * \param v3d: The active View3D (only to define active layers for instantiated objects & groups, can be NULL). */ void BLO_library_link_end(Main *mainl, BlendHandle **bh, short flag, Scene *scene, View3D *v3d) { diff --git a/source/blender/blenloader/intern/writefile.c b/source/blender/blenloader/intern/writefile.c index baec40335b2..7a915f6b8ca 100644 --- a/source/blender/blenloader/intern/writefile.c +++ b/source/blender/blenloader/intern/writefile.c @@ -403,8 +403,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) { @@ -453,8 +453,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) diff --git a/source/blender/bmesh/intern/bmesh_construct.c b/source/blender/bmesh/intern/bmesh_construct.c index 8f124afc55b..68f08025e5a 100644 --- a/source/blender/bmesh/intern/bmesh_construct.c +++ b/source/blender/bmesh/intern/bmesh_construct.c @@ -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, diff --git a/source/blender/bmesh/intern/bmesh_core.c b/source/blender/bmesh/intern/bmesh_core.c index 97f1bad08b7..c384497e0d1 100644 --- a/source/blender/bmesh/intern/bmesh_core.c +++ b/source/blender/bmesh/intern/bmesh_core.c @@ -420,11 +420,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, @@ -2395,7 +2395,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. diff --git a/source/blender/bmesh/intern/bmesh_mesh_conv.c b/source/blender/bmesh/intern/bmesh_mesh_conv.c index 2259a7dfe09..fdd4ad084d1 100644 --- a/source/blender/bmesh/intern/bmesh_mesh_conv.c +++ b/source/blender/bmesh/intern/bmesh_mesh_conv.c @@ -592,7 +592,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, diff --git a/source/blender/bmesh/intern/bmesh_mods.c b/source/blender/bmesh/intern/bmesh_mods.c index dfa3486227f..e95d5239caf 100644 --- a/source/blender/bmesh/intern/bmesh_mods.c +++ b/source/blender/bmesh/intern/bmesh_mods.c @@ -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) diff --git a/source/blender/bmesh/intern/bmesh_operators.c b/source/blender/bmesh/intern/bmesh_operators.c index 62d892712fd..546bd9fb461 100644 --- a/source/blender/bmesh/intern/bmesh_operators.c +++ b/source/blender/bmesh/intern/bmesh_operators.c @@ -1375,7 +1375,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( diff --git a/source/blender/bmesh/intern/bmesh_polygon.c b/source/blender/bmesh/intern/bmesh_polygon.c index 5e3f5958a32..9751c2d8aef 100644 --- a/source/blender/bmesh/intern/bmesh_polygon.c +++ b/source/blender/bmesh/intern/bmesh_polygon.c @@ -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 */ diff --git a/source/blender/bmesh/intern/bmesh_query.c b/source/blender/bmesh/intern/bmesh_query.c index 13e2029381e..78fb28bda2f 100644 --- a/source/blender/bmesh/intern/bmesh_query.c +++ b/source/blender/bmesh/intern/bmesh_query.c @@ -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. * diff --git a/source/blender/bmesh/operators/bmo_fill_grid.c b/source/blender/bmesh/operators/bmo_fill_grid.c index dc4ebf50754..a20555cf0c0 100644 --- a/source/blender/bmesh/operators/bmo_fill_grid.c +++ b/source/blender/bmesh/operators/bmo_fill_grid.c @@ -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, diff --git a/source/blender/bmesh/operators/bmo_normals.c b/source/blender/bmesh/operators/bmo_normals.c index 73dbee25be3..78094d3279c 100644 --- a/source/blender/bmesh/operators/bmo_normals.c +++ b/source/blender/bmesh/operators/bmo_normals.c @@ -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) { diff --git a/source/blender/bmesh/operators/bmo_primitive.c b/source/blender/bmesh/operators/bmo_primitive.c index fd9b88ca4d3..dee61440bc9 100644 --- a/source/blender/bmesh/operators/bmo_primitive.c +++ b/source/blender/bmesh/operators/bmo_primitive.c @@ -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) { diff --git a/source/blender/bmesh/tools/bmesh_bisect_plane.c b/source/blender/bmesh/tools/bmesh_bisect_plane.c index 4bf5526095f..13ff04b0e2e 100644 --- a/source/blender/bmesh/tools/bmesh_bisect_plane.c +++ b/source/blender/bmesh/tools/bmesh_bisect_plane.c @@ -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], diff --git a/source/blender/bmesh/tools/bmesh_decimate_collapse.c b/source/blender/bmesh/tools/bmesh_decimate_collapse.c index c1b2bc2625b..2faf6b81461 100644 --- a/source/blender/bmesh/tools/bmesh_decimate_collapse.c +++ b/source/blender/bmesh/tools/bmesh_decimate_collapse.c @@ -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. diff --git a/source/blender/bmesh/tools/bmesh_decimate_unsubdivide.c b/source/blender/bmesh/tools/bmesh_decimate_unsubdivide.c index f0ac6c673c9..63000b1b4db 100644 --- a/source/blender/bmesh/tools/bmesh_decimate_unsubdivide.c +++ b/source/blender/bmesh/tools/bmesh_decimate_unsubdivide.c @@ -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 diff --git a/source/blender/bmesh/tools/bmesh_edgenet.c b/source/blender/bmesh/tools/bmesh_edgenet.c index df9d07036af..acc9225424b 100644 --- a/source/blender/bmesh/tools/bmesh_edgenet.c +++ b/source/blender/bmesh/tools/bmesh_edgenet.c @@ -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, diff --git a/source/blender/bmesh/tools/bmesh_edgesplit.c b/source/blender/bmesh/tools/bmesh_edgesplit.c index 3a844a0b8d9..b7494fd87bc 100644 --- a/source/blender/bmesh/tools/bmesh_edgesplit.c +++ b/source/blender/bmesh/tools/bmesh_edgesplit.c @@ -36,9 +36,9 @@ #include "bmesh_edgesplit.h" /* own include */ /** - * \param use_verts Use flagged verts instead of edges. - * \param tag_only Only split tagged edges. - * \param copy_select Copy selection history. + * \param use_verts: Use flagged verts instead of edges. + * \param tag_only: Only split tagged edges. + * \param copy_select: Copy selection history. */ void BM_mesh_edgesplit( BMesh *bm, diff --git a/source/blender/bmesh/tools/bmesh_intersect.c b/source/blender/bmesh/tools/bmesh_intersect.c index 49165b48668..6da32f5e874 100644 --- a/source/blender/bmesh/tools/bmesh_intersect.c +++ b/source/blender/bmesh/tools/bmesh_intersect.c @@ -977,7 +977,7 @@ static int isect_bvhtree_point_v3( * Intersect tessellated faces * leaving the resulting edges tagged. * - * \param test_fn Return value: -1: skip, 0: tree_a, 1: tree_b (use_self == false) + * \param test_fn: Return value: -1: skip, 0: tree_a, 1: tree_b (use_self == false) * \param boolean_mode -1: no-boolean, 0: intersection... see #BMESH_ISECT_BOOLEAN_ISECT. * \return true if the mesh is changed (intersections cut or faces removed from boolean). */ diff --git a/source/blender/bmesh/tools/bmesh_region_match.c b/source/blender/bmesh/tools/bmesh_region_match.c index e83ba73ad01..f75999386e1 100644 --- a/source/blender/bmesh/tools/bmesh_region_match.c +++ b/source/blender/bmesh/tools/bmesh_region_match.c @@ -1374,7 +1374,7 @@ static void bm_vert_fasthash_destroy( /** * Take a face-region and return a list of matching face-regions. * - * \param faces_region A single, contiguous face-region. + * \param faces_region: A single, contiguous face-region. * \return A list of matching null-terminated face-region arrays. */ int BM_mesh_region_match( diff --git a/source/blender/collada/DocumentImporter.h b/source/blender/collada/DocumentImporter.h index 68a67005ff0..bdb84dd9104 100644 --- a/source/blender/collada/DocumentImporter.h +++ b/source/blender/collada/DocumentImporter.h @@ -83,7 +83,7 @@ public: /** * This method will be called if an error in the loading process occurred and the loader cannot * continue to load. The writer should undo all operations that have been performed. - * \param errorMessage A message containing information about the error that occurred. + * \param errorMessage: A message containing information about the error that occurred. */ void cancel(const COLLADAFW::String& errorMessage); diff --git a/source/blender/compositor/COM_compositor.h b/source/blender/compositor/COM_compositor.h index dbdcb8b4924..b481b4ec100 100644 --- a/source/blender/compositor/COM_compositor.h +++ b/source/blender/compositor/COM_compositor.h @@ -281,13 +281,13 @@ extern "C" { * It can be executed during editing (blenkernel/node.c) or rendering * (renderer/pipeline.c) * - * \param rd [struct RenderData] + * \param rd: [struct RenderData] * Render data for this composite, this won't always belong to a scene. * - * \param editingtree [struct bNodeTree] + * \param editingtree: [struct bNodeTree] * reference to the compositor editing tree * - * \param rendering [true false] + * \param rendering: [true false] * This parameter determines whether the function is called from rendering (true) or editing (false). * based on this setting the system will work differently: * - during rendering only Composite & the File output node will be calculated @@ -304,10 +304,10 @@ extern "C" { * - output nodes can have different priorities in the WorkScheduler. * This is implemented in the COM_execute function. * - * \param viewSettings + * \param viewSettings: * reference to view settings used for color management * - * \param displaySettings + * \param displaySettings: * reference to display settings used for color management * * OCIO_TODO: this options only used in rare cases, namely in output file node, diff --git a/source/blender/compositor/intern/COM_CPUDevice.h b/source/blender/compositor/intern/COM_CPUDevice.h index 52dcbb3a168..d3b63f0d079 100644 --- a/source/blender/compositor/intern/COM_CPUDevice.h +++ b/source/blender/compositor/intern/COM_CPUDevice.h @@ -35,7 +35,7 @@ public: /** * \brief execute a WorkPackage - * \param work the WorkPackage to execute + * \param work: the WorkPackage to execute */ void execute(WorkPackage *work); diff --git a/source/blender/compositor/intern/COM_Converter.h b/source/blender/compositor/intern/COM_Converter.h index 3aaf0545222..642f51ee7e5 100644 --- a/source/blender/compositor/intern/COM_Converter.h +++ b/source/blender/compositor/intern/COM_Converter.h @@ -63,8 +63,8 @@ public: * * \note this method is called when conversion is needed. * - * \param link the NodeLink what needs conversion - * \param system the ExecutionSystem to add the conversion to. + * \param link: the NodeLink what needs conversion + * \param system: the ExecutionSystem to add the conversion to. * \see NodeLink - a link between two sockets */ static NodeOperation *convertDataType(NodeOperationOutput *from, NodeOperationInput *to); @@ -75,8 +75,8 @@ public: * \note Conversion logic is implemented in this method * \see InputSocketResizeMode for the possible conversions. * - * \param link the NodeLink what needs conversion - * \param system the ExecutionSystem to add the conversion to. + * \param link: the NodeLink what needs conversion + * \param system: the ExecutionSystem to add the conversion to. * \see NodeLink - a link between two sockets */ static void convertResolution(NodeOperationBuilder &builder, NodeOperationOutput *fromSocket, NodeOperationInput *toSocket); diff --git a/source/blender/compositor/intern/COM_Device.h b/source/blender/compositor/intern/COM_Device.h index 4d6e1673aa1..abd0dfa5749 100644 --- a/source/blender/compositor/intern/COM_Device.h +++ b/source/blender/compositor/intern/COM_Device.h @@ -51,7 +51,7 @@ public: /** * \brief execute a WorkPackage - * \param work the WorkPackage to execute + * \param work: the WorkPackage to execute */ virtual void execute(WorkPackage *work) = 0; diff --git a/source/blender/compositor/intern/COM_ExecutionGroup.h b/source/blender/compositor/intern/COM_ExecutionGroup.h index f85c1759d8f..8f170aab2fb 100644 --- a/source/blender/compositor/intern/COM_ExecutionGroup.h +++ b/source/blender/compositor/intern/COM_ExecutionGroup.h @@ -181,7 +181,7 @@ private: // methods /** * \brief check whether parameter operation can be added to the execution group - * \param operation the operation to be added + * \param operation: the operation to be added */ bool canContainOperation(NodeOperation *operation); @@ -210,9 +210,9 @@ private: /** * \brief try to schedule a specific chunk. * \note scheduling succeeds when all input requirements are met and the chunks hasn't been scheduled yet. - * \param graph - * \param xChunk - * \param yChunk + * \param graph: + * \param xChunk: + * \param yChunk: * \return [true:false] * true: package(s) are scheduled * false: scheduling is deferred (depending workpackages are scheduled) @@ -223,8 +223,8 @@ private: * \brief try to schedule a specific area. * \note Check if a certain area is available, when not available this are will be checked. * \note This method is called from other ExecutionGroup's. - * \param graph - * \param rect + * \param graph: + * \param rect: * \return [true:false] * true: package(s) are scheduled * false: scheduling is deferred (depending workpackages are scheduled) @@ -233,16 +233,16 @@ private: /** * \brief add a chunk to the WorkScheduler. - * \param chunknumber + * \param chunknumber: */ bool scheduleChunk(unsigned int chunkNumber); /** * \brief determine the area of interest of a certain input area * \note This method only evaluates a single ReadBufferOperation - * \param input the input area - * \param readOperation The ReadBufferOperation where the area needs to be evaluated - * \param output the area needed of the ReadBufferOperation. Result + * \param input: the input area + * \param readOperation: The ReadBufferOperation where the area needs to be evaluated + * \param output: the area needed of the ReadBufferOperation. Result */ void determineDependingAreaOfInterest(rcti *input, ReadBufferOperation *readOperation, rcti *output); @@ -256,8 +256,8 @@ public: * \brief add an operation to this ExecutionGroup * \note this method will add input of the operations recursively * \note this method can create multiple ExecutionGroup's - * \param system - * \param operation + * \param system: + * \param operation: * \return True if the operation was successfully added */ bool addOperation(NodeOperation *operation); @@ -272,19 +272,19 @@ public: /** * \brief set whether this ExecutionGroup is an output - * \param isOutput + * \param isOutput: */ void setOutputExecutionGroup(int isOutput) { this->m_isOutput = isOutput; } /** * \brief determine the resolution of this ExecutionGroup - * \param resolution + * \param resolution: */ void determineResolution(unsigned int resolution[2]); /** * \brief set the resolution of this executiongroup - * \param resolution + * \param resolution: */ void setResolution(unsigned int resolution[2]) { this->m_width = resolution[0]; this->m_height = resolution[1]; } @@ -325,7 +325,7 @@ public: /** * \brief get all inputbuffers needed to calculate an chunk * \note all inputbuffers must be executed - * \param chunkNumber the chunk to be calculated + * \param chunkNumber: the chunk to be calculated * \return (MemoryBuffer **) the inputbuffers */ MemoryBuffer **getInputBuffersCPU(); @@ -333,23 +333,23 @@ public: /** * \brief get all inputbuffers needed to calculate an chunk * \note all inputbuffers must be executed - * \param chunkNumber the chunk to be calculated + * \param chunkNumber: the chunk to be calculated * \return (MemoryBuffer **) the inputbuffers */ MemoryBuffer **getInputBuffersOpenCL(int chunkNumber); /** * \brief allocate the outputbuffer of a chunk - * \param chunkNumber the number of the chunk in the ExecutionGroup - * \param rect the rect of that chunk + * \param chunkNumber: the number of the chunk in the ExecutionGroup + * \param rect: the rect of that chunk * \see determineChunkRect */ MemoryBuffer *allocateOutputBuffer(int chunkNumber, rcti *rect); /** * \brief after a chunk is executed the needed resources can be freed or unlocked. - * \param chunknumber - * \param memorybuffers + * \param chunknumber: + * \param memorybuffers: */ void finalizeChunkExecution(int chunkNumber, MemoryBuffer **memoryBuffers); @@ -372,7 +372,7 @@ public: * After determining the order of the chunks the chunks will be scheduled * * \see ViewerOperation - * \param system + * \param system: */ void execute(ExecutionSystem *system); @@ -380,7 +380,7 @@ public: * \brief this method determines the MemoryProxy's where this execution group depends on. * \note After this method determineDependingAreaOfInterest can be called to determine * \note the area of the MemoryProxy.creator that has to be executed. - * \param memoryProxies result + * \param memoryProxies: result */ void determineDependingMemoryProxies(vector<MemoryProxy *> *memoryProxies); diff --git a/source/blender/compositor/intern/COM_ExecutionSystem.h b/source/blender/compositor/intern/COM_ExecutionSystem.h index 83c2918f480..13e393a4236 100644 --- a/source/blender/compositor/intern/COM_ExecutionSystem.h +++ b/source/blender/compositor/intern/COM_ExecutionSystem.h @@ -147,8 +147,8 @@ public: * \brief Create a new ExecutionSystem and initialize it with the * editingtree. * - * \param editingtree [bNodeTree *] - * \param rendering [true false] + * \param editingtree: [bNodeTree *] + * \param rendering: [true false] */ ExecutionSystem(RenderData *rd, Scene *scene, bNodeTree *editingtree, bool rendering, bool fastcalculation, const ColorManagedViewSettings *viewSettings, const ColorManagedDisplaySettings *displaySettings, diff --git a/source/blender/compositor/intern/COM_MemoryBuffer.h b/source/blender/compositor/intern/COM_MemoryBuffer.h index 085cf8708d7..17ee17316fb 100644 --- a/source/blender/compositor/intern/COM_MemoryBuffer.h +++ b/source/blender/compositor/intern/COM_MemoryBuffer.h @@ -279,7 +279,7 @@ public: /** * \brief add the content from otherBuffer to this MemoryBuffer - * \param otherBuffer source buffer + * \param otherBuffer: source buffer * * \note take care when running this on a new buffer since it wont fill in * uninitialized values in areas where the buffers don't overlap. diff --git a/source/blender/compositor/intern/COM_MemoryProxy.h b/source/blender/compositor/intern/COM_MemoryProxy.h index ee5dd684b38..7da7f871036 100644 --- a/source/blender/compositor/intern/COM_MemoryProxy.h +++ b/source/blender/compositor/intern/COM_MemoryProxy.h @@ -73,7 +73,7 @@ public: /** * \brief set the ExecutionGroup that can be scheduled to calculate a certain chunk. - * \param group the ExecutionGroup to set + * \param group: the ExecutionGroup to set */ void setExecutor(ExecutionGroup *executor) { this->m_executor = executor; } @@ -84,7 +84,7 @@ public: /** * \brief set the WriteBufferOperation that is responsible for writing to this MemoryProxy - * \param operation + * \param operation: */ void setWriteBufferOperation(WriteBufferOperation *operation) { this->m_writeBufferOperation = operation; } diff --git a/source/blender/compositor/intern/COM_Node.h b/source/blender/compositor/intern/COM_Node.h index 9dea9d715a8..ab70bd6e617 100644 --- a/source/blender/compositor/intern/COM_Node.h +++ b/source/blender/compositor/intern/COM_Node.h @@ -105,13 +105,13 @@ public: /** * \brief set the reference to the bNode * \note used in Node instances to receive the storage/settings and complex node for highlight during execution - * \param bNode + * \param bNode: */ void setbNode(bNode *node) {this->m_editorNode = node;} /** * \brief set the reference to the bNodeTree - * \param bNodeTree + * \param bNodeTree: */ void setbNodeTree(bNodeTree *nodetree) {this->m_editorNodeTree = nodetree;} @@ -127,21 +127,21 @@ public: /** * get the reference to a certain outputsocket - * \param index + * \param index: * the index of the needed outputsocket */ NodeOutput *getOutputSocket(const unsigned int index) const; /** * get the reference to the first outputsocket - * \param index + * \param index: * the index of the needed outputsocket */ inline NodeOutput *getOutputSocket() const { return getOutputSocket(0); } /** * get the reference to a certain inputsocket - * \param index + * \param index: * the index of the needed inputsocket */ NodeInput *getInputSocket(const unsigned int index) const; @@ -153,7 +153,7 @@ public: /** * \brief Is this node in the active group (the group that is being edited) - * \param isInActiveGroup + * \param isInActiveGroup: */ void setIsInActiveGroup(bool value) { this->m_inActiveGroup = value; } @@ -170,8 +170,8 @@ public: * * \todo this must be described further * - * \param system the ExecutionSystem where the operations need to be added - * \param context reference to the CompositorContext + * \param system: the ExecutionSystem where the operations need to be added + * \param context: reference to the CompositorContext */ virtual void convertToOperations(NodeConverter &converter, const CompositorContext &context) const = 0; @@ -193,7 +193,7 @@ protected: /** * \brief add an NodeInput to the collection of inputsockets * \note may only be called in an constructor - * \param socket the NodeInput to add + * \param socket: the NodeInput to add */ void addInputSocket(DataType datatype); void addInputSocket(DataType datatype, bNodeSocket *socket); @@ -201,7 +201,7 @@ protected: /** * \brief add an NodeOutput to the collection of outputsockets * \note may only be called in an constructor - * \param socket the NodeOutput to add + * \param socket: the NodeOutput to add */ void addOutputSocket(DataType datatype); void addOutputSocket(DataType datatype, bNodeSocket *socket); diff --git a/source/blender/compositor/intern/COM_NodeOperation.h b/source/blender/compositor/intern/COM_NodeOperation.h index c0957d57040..10161343444 100644 --- a/source/blender/compositor/intern/COM_NodeOperation.h +++ b/source/blender/compositor/intern/COM_NodeOperation.h @@ -143,8 +143,8 @@ public: /** * \brief determine the resolution of this node * \note this method will not set the resolution, this is the responsibility of the caller - * \param resolution the result of this operation - * \param preferredResolution the preferable resolution as no resolution could be determined + * \param resolution: the result of this operation + * \param preferredResolution: the preferable resolution as no resolution could be determined */ virtual void determineResolution(unsigned int resolution[2], unsigned int preferredResolution[2]); @@ -155,7 +155,7 @@ public: * * \see ExecutionSystem * \group check - * \param rendering [true false] + * \param rendering: [true false] * true: rendering * false: editing * @@ -171,9 +171,9 @@ public: /** * \brief when a chunk is executed by a CPUDevice, this method is called * \ingroup execution - * \param rect the rectangle of the chunk (location and size) - * \param chunkNumber the chunkNumber to be calculated - * \param memoryBuffers all input MemoryBuffer's needed + * \param rect: the rectangle of the chunk (location and size) + * \param chunkNumber: the chunkNumber to be calculated + * \param memoryBuffers: all input MemoryBuffer's needed */ virtual void executeRegion(rcti * /*rect*/, unsigned int /*chunkNumber*/) {} @@ -182,13 +182,13 @@ public: * \brief when a chunk is executed by an OpenCLDevice, this method is called * \ingroup execution * \note this method is only implemented in WriteBufferOperation - * \param context the OpenCL context - * \param program the OpenCL program containing all compositor kernels - * \param queue the OpenCL command queue of the device the chunk is executed on - * \param rect the rectangle of the chunk (location and size) - * \param chunkNumber the chunkNumber to be calculated - * \param memoryBuffers all input MemoryBuffer's needed - * \param outputBuffer the outputbuffer to write to + * \param context: the OpenCL context + * \param program: the OpenCL program containing all compositor kernels + * \param queue: the OpenCL command queue of the device the chunk is executed on + * \param rect: the rectangle of the chunk (location and size) + * \param chunkNumber: the chunkNumber to be calculated + * \param memoryBuffers: all input MemoryBuffer's needed + * \param outputBuffer: the outputbuffer to write to */ virtual void executeOpenCLRegion(OpenCLDevice * /*device*/, rcti * /*rect*/, @@ -199,14 +199,14 @@ public: /** * \brief custom handle to add new tasks to the OpenCL command queue in order to execute a chunk on an GPUDevice * \ingroup execution - * \param context the OpenCL context - * \param program the OpenCL program containing all compositor kernels - * \param queue the OpenCL command queue of the device the chunk is executed on - * \param outputMemoryBuffer the allocated memory buffer in main CPU memory - * \param clOutputBuffer the allocated memory buffer in OpenCLDevice memory - * \param inputMemoryBuffers all input MemoryBuffer's needed - * \param clMemToCleanUp all created cl_mem references must be added to this list. Framework will clean this after execution - * \param clKernelsToCleanUp all created cl_kernel references must be added to this list. Framework will clean this after execution + * \param context: the OpenCL context + * \param program: the OpenCL program containing all compositor kernels + * \param queue: the OpenCL command queue of the device the chunk is executed on + * \param outputMemoryBuffer: the allocated memory buffer in main CPU memory + * \param clOutputBuffer: the allocated memory buffer in OpenCLDevice memory + * \param inputMemoryBuffers: all input MemoryBuffer's needed + * \param clMemToCleanUp: all created cl_mem references must be added to this list. Framework will clean this after execution + * \param clKernelsToCleanUp: all created cl_kernel references must be added to this list. Framework will clean this after execution */ virtual void executeOpenCL(OpenCLDevice * /*device*/, MemoryBuffer * /*outputMemoryBuffer*/, @@ -222,7 +222,7 @@ public: /** * \brief set the resolution - * \param resolution the resolution to set + * \param resolution: the resolution to set */ void setResolution(unsigned int resolution[2]) { if (!isResolutionSet()) { @@ -271,7 +271,7 @@ public: /** * \brief set the index of the input socket that will determine the resolution of this operation - * \param index the index to set + * \param index: the index to set */ void setResolutionInputSocketIndex(unsigned int index); @@ -397,8 +397,8 @@ public: /** * \brief determine the resolution of this data going through this socket - * \param resolution the result of this operation - * \param preferredResolution the preferable resolution as no resolution could be determined + * \param resolution: the result of this operation + * \param preferredResolution: the preferable resolution as no resolution could be determined */ void determineResolution(unsigned int resolution[2], unsigned int preferredResolution[2]); diff --git a/source/blender/compositor/intern/COM_OpenCLDevice.h b/source/blender/compositor/intern/COM_OpenCLDevice.h index 4f2c71e23e7..940ed233ecc 100644 --- a/source/blender/compositor/intern/COM_OpenCLDevice.h +++ b/source/blender/compositor/intern/COM_OpenCLDevice.h @@ -66,10 +66,10 @@ private: public: /** * \brief constructor with opencl device - * \param context - * \param device - * \param program - * \param vendorID + * \param context: + * \param device: + * \param program: + * \param vendorID: */ OpenCLDevice(cl_context context, cl_device_id device, cl_program program, cl_int vendorId); @@ -90,13 +90,13 @@ public: /** * \brief execute a WorkPackage - * \param work the WorkPackage to execute + * \param work: the WorkPackage to execute */ void execute(WorkPackage *work); /** * \brief determine an image format - * \param memorybuffer + * \param memorybuffer: */ static const cl_image_format *determineImageFormat(MemoryBuffer *memoryBuffer); diff --git a/source/blender/compositor/intern/COM_SocketReader.h b/source/blender/compositor/intern/COM_SocketReader.h index 1e0629ae2b4..ec1c200fd81 100644 --- a/source/blender/compositor/intern/COM_SocketReader.h +++ b/source/blender/compositor/intern/COM_SocketReader.h @@ -58,10 +58,10 @@ protected: /** * \brief calculate a single pixel * \note this method is called for non-complex - * \param result is a float[4] array to store the result - * \param x the x-coordinate of the pixel to calculate in image space - * \param y the y-coordinate of the pixel to calculate in image space - * \param inputBuffers chunks that can be read by their ReadBufferOperation. + * \param result: is a float[4] array to store the result + * \param x: the x-coordinate of the pixel to calculate in image space + * \param y: the y-coordinate of the pixel to calculate in image space + * \param inputBuffers: chunks that can be read by their ReadBufferOperation. */ virtual void executePixelSampled(float /*output*/[4], float /*x*/, @@ -71,11 +71,11 @@ protected: /** * \brief calculate a single pixel * \note this method is called for complex - * \param result is a float[4] array to store the result - * \param x the x-coordinate of the pixel to calculate in image space - * \param y the y-coordinate of the pixel to calculate in image space - * \param inputBuffers chunks that can be read by their ReadBufferOperation. - * \param chunkData chunk specific data a during execution time. + * \param result: is a float[4] array to store the result + * \param x: the x-coordinate of the pixel to calculate in image space + * \param y: the y-coordinate of the pixel to calculate in image space + * \param inputBuffers: chunks that can be read by their ReadBufferOperation. + * \param chunkData: chunk specific data a during execution time. */ virtual void executePixel(float output[4], int x, int y, void * /*chunkData*/) { executePixelSampled(output, x, y, COM_PS_NEAREST); @@ -84,12 +84,12 @@ protected: /** * \brief calculate a single pixel using an EWA filter * \note this method is called for complex - * \param result is a float[4] array to store the result - * \param x the x-coordinate of the pixel to calculate in image space - * \param y the y-coordinate of the pixel to calculate in image space - * \param dx - * \param dy - * \param inputBuffers chunks that can be read by their ReadBufferOperation. + * \param result: is a float[4] array to store the result + * \param x: the x-coordinate of the pixel to calculate in image space + * \param y: the y-coordinate of the pixel to calculate in image space + * \param dx: + * \param dy: + * \param inputBuffers: chunks that can be read by their ReadBufferOperation. */ virtual void executePixelFiltered(float /*output*/[4], float /*x*/, float /*y*/, diff --git a/source/blender/compositor/intern/COM_WorkPackage.h b/source/blender/compositor/intern/COM_WorkPackage.h index 9d8efa12ca5..0cfabcae4f2 100644 --- a/source/blender/compositor/intern/COM_WorkPackage.h +++ b/source/blender/compositor/intern/COM_WorkPackage.h @@ -45,8 +45,8 @@ private: public: /** * constructor - * \param group the ExecutionGroup - * \param chunkNumber the number of the chunk + * \param group: the ExecutionGroup + * \param chunkNumber: the number of the chunk */ WorkPackage(ExecutionGroup *group, unsigned int chunkNumber); diff --git a/source/blender/compositor/intern/COM_WorkScheduler.h b/source/blender/compositor/intern/COM_WorkScheduler.h index 6b134c8a4c6..6927127b63d 100644 --- a/source/blender/compositor/intern/COM_WorkScheduler.h +++ b/source/blender/compositor/intern/COM_WorkScheduler.h @@ -61,8 +61,8 @@ public: * when ExecutionGroup.isOpenCL is set the work will be handled by a OpenCLDevice * otherwise the work is scheduled for an CPUDevice * \see ExecutionGroup.execute - * \param group the execution group - * \param chunkNumber the number of the chunk in the group to be executed + * \param group: the execution group + * \param chunkNumber: the number of the chunk in the group to be executed */ static void schedule(ExecutionGroup *group, int chunkNumber); diff --git a/source/blender/compositor/operations/COM_BokehImageOperation.h b/source/blender/compositor/operations/COM_BokehImageOperation.h index c4616e5fecb..510ff6377a0 100644 --- a/source/blender/compositor/operations/COM_BokehImageOperation.h +++ b/source/blender/compositor/operations/COM_BokehImageOperation.h @@ -90,18 +90,18 @@ private: /** * \brief determine the coordinate of a flap cornder * - * \param r result in bokehimage space are stored [x,y] - * \param flapNumber the flap number to calculate - * \param distance the lens distance is used to simulate lens shifts + * \param r: result in bokehimage space are stored [x,y] + * \param flapNumber: the flap number to calculate + * \param distance: the lens distance is used to simulate lens shifts */ void detemineStartPointOfFlap(float r[2], int flapNumber, float distance); /** * \brief Determine if a coordinate is inside the bokeh image * - * \param distance the distance that will be used. This parameter is modified a bit to mimic lens shifts - * \param x the x coordinate of the pixel to evaluate - * \param y the y coordinate of the pixel to evaluate + * \param distance: the distance that will be used. This parameter is modified a bit to mimic lens shifts + * \param x: the x coordinate of the pixel to evaluate + * \param y: the y coordinate of the pixel to evaluate * \return float range 0..1 0 is completely outside */ float isInsideBokeh(float distance, float x, float y); @@ -125,14 +125,14 @@ public: /** * \brief determine the resolution of this operation. currently fixed at [COM_BLUR_BOKEH_PIXELS, COM_BLUR_BOKEH_PIXELS] - * \param resolution - * \param preferredResolution + * \param resolution: + * \param preferredResolution: */ void determineResolution(unsigned int resolution[2], unsigned int preferredResolution[2]); /** * \brief set the node data - * \param data + * \param data: */ void setData(NodeBokehImage *data) { this->m_data = data; } diff --git a/source/blender/compositor/operations/COM_PixelateOperation.h b/source/blender/compositor/operations/COM_PixelateOperation.h index cd91c2ccc05..381c723f7e8 100644 --- a/source/blender/compositor/operations/COM_PixelateOperation.h +++ b/source/blender/compositor/operations/COM_PixelateOperation.h @@ -41,7 +41,7 @@ private: public: /** * \brief PixelateOperation - * \param dataType the datatype to create this operator for (saves datatype conversions) + * \param dataType: the datatype to create this operator for (saves datatype conversions) */ PixelateOperation(DataType dataType); @@ -57,10 +57,10 @@ public: /** * \brief executePixel - * \param output result - * \param x x-coordinate - * \param y y-coordinate - * \param sampler sampler + * \param output: result + * \param x: x-coordinate + * \param y: y-coordinate + * \param sampler: sampler */ void executePixelSampled(float output[4], float x, float y, PixelSampler sampler); }; diff --git a/source/blender/compositor/operations/COM_SunBeamsOperation.cpp b/source/blender/compositor/operations/COM_SunBeamsOperation.cpp index e556d366353..10d128d01c3 100644 --- a/source/blender/compositor/operations/COM_SunBeamsOperation.cpp +++ b/source/blender/compositor/operations/COM_SunBeamsOperation.cpp @@ -105,9 +105,9 @@ struct BufferLineAccumulator { * at dist_min from the target pt. This way the loop can be canceled as soon as it runs * out of the buffer rect, because no pixels further along the line can contribute. * - * \param x, y Start location in the buffer - * \param num Total steps in the loop - * \param v, dv Vertical offset in sector space, for line offset perpendicular to the loop axis + * \param x, y: Start location in the buffer + * \param num: Total steps in the loop + * \param v, dv: Vertical offset in sector space, for line offset perpendicular to the loop axis */ static float *init_buffer_iterator(MemoryBuffer *input, const float source[2], const float co[2], float dist_min, float dist_max, diff --git a/source/blender/editors/animation/anim_channels_edit.c b/source/blender/editors/animation/anim_channels_edit.c index c125c129e1d..8900e19def4 100644 --- a/source/blender/editors/animation/anim_channels_edit.c +++ b/source/blender/editors/animation/anim_channels_edit.c @@ -847,8 +847,8 @@ static bool rearrange_island_bottom(ListBase *list, tReorderChannelIsland *islan /** * typedef for channel rearranging function * - * \param list List of tReorderChannelIsland's that channels belong to - * \param island Island to be moved + * \param list: List of tReorderChannelIsland's that channels belong to + * \param island: Island to be moved * \return Whether operation was a success */ typedef bool (*AnimChanRearrangeFp)(ListBase *list, tReorderChannelIsland *island); diff --git a/source/blender/editors/animation/anim_markers.c b/source/blender/editors/animation/anim_markers.c index 05682292485..821cbd32705 100644 --- a/source/blender/editors/animation/anim_markers.c +++ b/source/blender/editors/animation/anim_markers.c @@ -120,12 +120,12 @@ ListBase *ED_animcontext_get_markers(const bAnimContext *ac) /** * Apply some transformation to markers after the fact * - * \param markers List of markers to affect - this may or may not be the scene markers list, so don't assume anything - * \param scene Current scene (for getting current frame) - * \param mode (TfmMode) transform mode that this transform is for - * \param value From the transform code, this is ``t->vec[0]`` + * \param markers: List of markers to affect - this may or may not be the scene markers list, so don't assume anything + * \param scene: Current scene (for getting current frame) + * \param mode: (TfmMode) transform mode that this transform is for + * \param value: From the transform code, this is ``t->vec[0]`` * (which is delta transform for grab/extend, and scale factor for scale) - * \param side (B/L/R) for 'extend' functionality, which side of current frame to use + * \param side: (B/L/R) for 'extend' functionality, which side of current frame to use */ int ED_markers_post_apply_transform(ListBase *markers, Scene *scene, int mode, float value, char side) { @@ -545,7 +545,7 @@ static bool ed_markers_poll_markers_exist(bContext *C) * "custom"/third-tier invoke() callback supplied as the last arg (which would normally * be the operator's invoke() callback elsewhere) * - * \param invoke_func "standard" invoke function that operator would otherwise have used. + * \param invoke_func: "standard" invoke function that operator would otherwise have used. * If NULL, the operator's standard exec() * callback will be called instead in the appropriate places. */ diff --git a/source/blender/editors/armature/armature_utils.c b/source/blender/editors/armature/armature_utils.c index c6cd9475008..46e1b868520 100644 --- a/source/blender/editors/armature/armature_utils.c +++ b/source/blender/editors/armature/armature_utils.c @@ -170,8 +170,8 @@ bool ED_armature_ebone_is_child_recursive(EditBone *ebone_parent, EditBone *ebon /** * Finds the first parent shared by \a ebone_child * - * \param ebone_child Children bones to search - * \param ebone_child_tot Size of the ebone_child array + * \param ebone_child: Children bones to search + * \param ebone_child_tot: Size of the ebone_child array * \return The shared parent or NULL. */ EditBone *ED_armature_ebone_find_shared_parent(EditBone *ebone_child[], const unsigned int ebone_child_tot) diff --git a/source/blender/editors/armature/pose_transform.c b/source/blender/editors/armature/pose_transform.c index 304a1f8df8c..f21d990a19e 100644 --- a/source/blender/editors/armature/pose_transform.c +++ b/source/blender/editors/armature/pose_transform.c @@ -296,10 +296,10 @@ static void set_pose_keys(Object *ob) /** * Perform paste pose, for a single bone. * - * \param ob Object where bone to paste to lives - * \param chan Bone that pose to paste comes from - * \param selOnly Only paste on selected bones - * \param flip Flip on x-axis + * \param ob: Object where bone to paste to lives + * \param chan: Bone that pose to paste comes from + * \param selOnly: Only paste on selected bones + * \param flip: Flip on x-axis * \return Whether the bone that we pasted to if we succeeded */ static bPoseChannel *pose_bone_do_paste(Object *ob, bPoseChannel *chan, const bool selOnly, const bool flip) diff --git a/source/blender/editors/gpencil/editaction_gpencil.c b/source/blender/editors/gpencil/editaction_gpencil.c index 3a3953579a6..0becffa0bc6 100644 --- a/source/blender/editors/gpencil/editaction_gpencil.c +++ b/source/blender/editors/gpencil/editaction_gpencil.c @@ -288,7 +288,7 @@ void ED_gplayer_frames_duplicate(bGPDlayer *gpl) } /* Set keyframe type for selected frames from given gp-layer - * \param type The type of keyframe (eBezTriple_KeyframeType) to set selected frames to + * \param type: The type of keyframe (eBezTriple_KeyframeType) to set selected frames to */ void ED_gplayer_frames_keytype_set(bGPDlayer *gpl, short type) { diff --git a/source/blender/editors/gpencil/gpencil_intern.h b/source/blender/editors/gpencil/gpencil_intern.h index f48736a15e1..229cc14719a 100644 --- a/source/blender/editors/gpencil/gpencil_intern.h +++ b/source/blender/editors/gpencil/gpencil_intern.h @@ -323,9 +323,9 @@ typedef enum ACTCONT_TYPES { * stopping on each usable layer + stroke pair (i.e. gpl and gps) * to perform some operations on the stroke. * - * \param gpl The identifier to use for the layer of the stroke being processed. + * \param gpl: The identifier to use for the layer of the stroke being processed. * Choose a suitable value to avoid name clashes. - * \param gps The identifier to use for current stroke being processed. + * \param gps: The identifier to use for current stroke being processed. * Choose a suitable value to avoid name clashes. */ #define GP_EDITABLE_STROKES_BEGIN(C, gpl, gps) \ diff --git a/source/blender/editors/gpencil/gpencil_utils.c b/source/blender/editors/gpencil/gpencil_utils.c index 2b49b2bd3d1..50c1c2075ac 100644 --- a/source/blender/editors/gpencil/gpencil_utils.c +++ b/source/blender/editors/gpencil/gpencil_utils.c @@ -397,12 +397,12 @@ const EnumPropertyItem *ED_gpencil_layers_with_new_enum_itemf( /** * Check whether a given stroke segment is inside a circular brush * - * \param mval The current screen-space coordinates (midpoint) of the brush - * \param mvalo The previous screen-space coordinates (midpoint) of the brush (NOT CURRENTLY USED) - * \param rad The radius of the brush + * \param mval: The current screen-space coordinates (midpoint) of the brush + * \param mvalo: The previous screen-space coordinates (midpoint) of the brush (NOT CURRENTLY USED) + * \param rad: The radius of the brush * - * \param x0, y0 The screen-space x and y coordinates of the start of the stroke segment - * \param x1, y1 The screen-space x and y coordinates of the end of the stroke segment + * \param x0, y0: The screen-space x and y coordinates of the start of the stroke segment. + * \param x1, y1: The screen-space x and y coordinates of the end of the stroke segment. */ bool gp_stroke_inside_circle(const int mval[2], const int UNUSED(mvalo[2]), int rad, int x0, int y0, int x1, int y1) @@ -558,8 +558,8 @@ void gp_point_conversion_init(bContext *C, GP_SpaceConversion *r_gsc) /** * Convert point to parent space * - * \param pt Original point - * \param diff_mat Matrix with the difference between original parent matrix + * \param pt: Original point + * \param diff_mat: Matrix with the difference between original parent matrix * \param[out] r_pt Pointer to new point after apply matrix */ void gp_point_to_parent_space(bGPDspoint *pt, float diff_mat[4][4], bGPDspoint *r_pt) @@ -769,10 +769,10 @@ bool gp_point_xy_to_3d(GP_SpaceConversion *gsc, Scene *scene, const float screen /** * Apply smooth to stroke point - * \param gps Stroke to smooth - * \param i Point index - * \param inf Amount of smoothing to apply - * \param affect_pressure Apply smoothing to pressure values too? + * \param gps: Stroke to smooth + * \param i: Point index + * \param inf: Amount of smoothing to apply + * \param affect_pressure: Apply smoothing to pressure values too? */ bool gp_smooth_stroke(bGPDstroke *gps, int i, float inf, bool affect_pressure) { @@ -851,9 +851,9 @@ bool gp_smooth_stroke(bGPDstroke *gps, int i, float inf, bool affect_pressure) /** * Apply smooth for strength 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 gp_smooth_stroke_strength(bGPDstroke *gps, int i, float inf) { @@ -889,9 +889,9 @@ bool gp_smooth_stroke_strength(bGPDstroke *gps, int i, float inf) /** * Apply smooth for thickness to stroke point (use pressure) -* \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 gp_smooth_stroke_thickness(bGPDstroke *gps, int i, float inf) { @@ -927,8 +927,8 @@ bool gp_smooth_stroke_thickness(bGPDstroke *gps, int i, float inf) /** * Subdivide a stroke once, by adding a point half way between each pair of existing points - * \param gps Stroke data - * \param new_totpoints Total number of points (after subdividing) + * \param gps: Stroke data + * \param new_totpoints: Total number of points (after subdividing) */ void gp_subdivide_stroke(bGPDstroke *gps, const int new_totpoints) { @@ -960,8 +960,8 @@ void gp_subdivide_stroke(bGPDstroke *gps, const int new_totpoints) /** * Add randomness to stroke - * \param gps Stroke data - * \param brush Brush data + * \param gps: Stroke data + * \param brush: Brush data */ void gp_randomize_stroke(bGPDstroke *gps, bGPDbrush *brush) { diff --git a/source/blender/editors/include/BIF_glutil.h b/source/blender/editors/include/BIF_glutil.h index efd66dd79cf..ceb1a4f416a 100644 --- a/source/blender/editors/include/BIF_glutil.h +++ b/source/blender/editors/include/BIF_glutil.h @@ -69,10 +69,10 @@ extern const unsigned char stipple_checker_8px[128]; * through \a angle. The arc is centered at the origin * and drawn in the XY plane. * - * \param start The initial angle (in radians). - * \param angle The length of the arc (in radians). - * \param radius The arc radius. - * \param nsegments The number of segments to use in drawing the arc. + * \param start: The initial angle (in radians). + * \param angle: The length of the arc (in radians). + * \param radius: The arc radius. + * \param nsegments: The number of segments to use in drawing the arc. */ void glutil_draw_lined_arc(float start, float angle, float radius, int nsegments); @@ -82,10 +82,10 @@ void glutil_draw_lined_arc(float start, float angle, float radius, int nsegments * \a angle. The arc is centered at the origin * and drawn in the XY plane. * - * \param start The initial angle (in radians). - * \param angle The length of the arc (in radians). - * \param radius The arc radius. - * \param nsegments The number of segments to use in drawing the arc. + * \param start: The initial angle (in radians). + * \param angle: The length of the arc (in radians). + * \param radius: The arc radius. + * \param nsegments: The number of segments to use in drawing the arc. */ void glutil_draw_filled_arc(float start, float angle, float radius, int nsegments); @@ -172,7 +172,7 @@ void glaDrawPixelsTexScaled_clipping(float x, float y, int img_w, int img_h, int * thus no reason to +-0.5 the coordinates or perform other silly * tricks. * - * \param screen_rect The screen rectangle to be defined for 2D drawing. + * \param screen_rect: The screen rectangle to be defined for 2D drawing. */ void glaDefine2DArea(struct rcti *screen_rect); diff --git a/source/blender/editors/interface/interface.c b/source/blender/editors/interface/interface.c index ab87e1dda55..c2a0d00b2cd 100644 --- a/source/blender/editors/interface/interface.c +++ b/source/blender/editors/interface/interface.c @@ -2124,7 +2124,7 @@ void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) } /** - * \param float_precision Override the button precision. + * \param float_precision: Override the button precision. */ static void ui_get_but_string_unit(uiBut *but, char *str, int len_max, double value, bool pad, int float_precision) { @@ -2187,8 +2187,8 @@ static float ui_get_but_step_unit(uiBut *but, float step_default) } /** - * \param float_precision For number buttons the precision to use or -1 to fallback to the button default. - * \param use_exp_float Use exponent representation of floats when out of reasonable range (outside of 1e3/1e-3). + * \param float_precision: For number buttons the precision to use or -1 to fallback to the button default. + * \param use_exp_float: Use exponent representation of floats when out of reasonable range (outside of 1e3/1e-3). */ void ui_but_string_get_ex(uiBut *but, char *str, const size_t maxlen, const int float_precision, const bool use_exp_float, bool *r_use_exp_float) { diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c index 64c3ae32eaa..d454d3bcbeb 100644 --- a/source/blender/editors/interface/interface_handlers.c +++ b/source/blender/editors/interface/interface_handlers.c @@ -2646,7 +2646,7 @@ static bool ui_textedit_delete_selection(uiBut *but, uiHandleButtonData *data) } /** - * \param x Screen space cursor location - #wmEvent.x + * \param x: Screen space cursor location - #wmEvent.x * * \note ``but->block->aspect`` is used here, so drawing button style is getting scaled too. */ @@ -6872,7 +6872,7 @@ static bool ui_but_find_select_in_enum__cmp(const uiBut *but_a, const uiBut *but /** * Finds the pressed button in an aligned row (typically an expanded enum). * - * \param direction Use when there may be multiple buttons pressed. + * \param direction: Use when there may be multiple buttons pressed. */ uiBut *ui_but_find_select_in_enum(uiBut *but, int direction) { diff --git a/source/blender/editors/mesh/editmesh_knife.c b/source/blender/editors/mesh/editmesh_knife.c index 9cc19d5194e..0b3c4dbc982 100644 --- a/source/blender/editors/mesh/editmesh_knife.c +++ b/source/blender/editors/mesh/editmesh_knife.c @@ -1390,7 +1390,7 @@ static bool bm_ray_cast_cb_elem_not_in_face_check(BMFace *f, void *user_data) * Check if \a p is visible (not clipped, not occluded by another face). * s in screen projection of p. * - * \param ele_test Optional vert/edge/face to use when \a p is on the surface of the geometry, + * \param ele_test: Optional vert/edge/face to use when \a p is on the surface of the geometry, * intersecting faces matching this face (or connected when an vert/edge) will be ignored. */ static bool point_is_visible( @@ -3003,7 +3003,7 @@ static bool edbm_mesh_knife_point_isect(LinkNode *polys, const float cent_ss[2]) } /** - * \param use_tag When set, tag all faces inside the polylines. + * \param use_tag: When set, tag all faces inside the polylines. */ void EDBM_mesh_knife(bContext *C, LinkNode *polys, bool use_tag, bool cut_through) { diff --git a/source/blender/editors/mesh/editmesh_rip.c b/source/blender/editors/mesh/editmesh_rip.c index 0c8bd560bb2..f23f0ae5fab 100644 --- a/source/blender/editors/mesh/editmesh_rip.c +++ b/source/blender/editors/mesh/editmesh_rip.c @@ -58,7 +58,7 @@ /** * helper to find edge for edge_rip, * - * \param inset is used so we get some useful distance + * \param inset: is used so we get some useful distance * when comparing multiple edges that meet at the same * point and would result in the same distance. */ diff --git a/source/blender/editors/mesh/editmesh_select.c b/source/blender/editors/mesh/editmesh_select.c index 968c276c8bd..4f3db525c1b 100644 --- a/source/blender/editors/mesh/editmesh_select.c +++ b/source/blender/editors/mesh/editmesh_select.c @@ -443,11 +443,11 @@ static void findnearestvert__doClosest(void *userData, BMVert *eve, const float /** * Nearest vertex under the cursor. * - * \param r_dist (in/out), minimal distance to the nearest and at the end, actual distance - * \param use_select_bias + * \param r_dist: (in/out), minimal distance to the nearest and at the end, actual distance + * \param use_select_bias: * - When true, selected vertice are given a 5 pixel bias to make them further than unselect verts. * - When false, unselected vertice are given the bias. - * \param use_cycle Cycle over elements within #FIND_NEAR_CYCLE_THRESHOLD_MIN in order of index. + * \param use_cycle: Cycle over elements within #FIND_NEAR_CYCLE_THRESHOLD_MIN in order of index. */ BMVert *EDBM_vert_find_nearest_ex( ViewContext *vc, float *r_dist, diff --git a/source/blender/editors/mesh/editmesh_utils.c b/source/blender/editors/mesh/editmesh_utils.c index 65b42571bbc..60aa410a665 100644 --- a/source/blender/editors/mesh/editmesh_utils.c +++ b/source/blender/editors/mesh/editmesh_utils.c @@ -993,12 +993,12 @@ static BMVert *cache_mirr_intptr_as_bmvert(intptr_t *index_lookup, int index) #define BM_SEARCH_MAXDIST_MIRR 0.00002f #define BM_CD_LAYER_ID "__mirror_index" /** - * \param em Editmesh. - * \param use_self Allow a vertex to point to its self (middle verts). - * \param use_select Restrict to selected verts. - * \param use_topology Use topology mirror. - * \param maxdist Distance for close point test. - * \param r_index Optional array to write into, as an alternative to a customdata layer (length of total verts). + * \param em: Editmesh. + * \param use_self: Allow a vertex to point to its self (middle verts). + * \param use_select: Restrict to selected verts. + * \param use_topology: Use topology mirror. + * \param maxdist: Distance for close point test. + * \param r_index: Optional array to write into, as an alternative to a customdata layer (length of total verts). */ void EDBM_verts_mirror_cache_begin_ex( BMEditMesh *em, const int axis, const bool use_self, const bool use_select, diff --git a/source/blender/editors/screen/area.c b/source/blender/editors/screen/area.c index 3ca989c92fe..5edd4ff63be 100644 --- a/source/blender/editors/screen/area.c +++ b/source/blender/editors/screen/area.c @@ -1635,7 +1635,7 @@ void ED_area_swapspace(bContext *C, ScrArea *sa1, ScrArea *sa2) } /** - * \param skip_ar_exit Skip calling area exit callback. Set for opening temp spaces. + * \param skip_ar_exit: Skip calling area exit callback. Set for opening temp spaces. */ void ED_area_newspace(bContext *C, ScrArea *sa, int type, const bool skip_ar_exit) { diff --git a/source/blender/editors/screen/glutil.c b/source/blender/editors/screen/glutil.c index 6e9a580e403..b83ee70fdb1 100644 --- a/source/blender/editors/screen/glutil.c +++ b/source/blender/editors/screen/glutil.c @@ -713,8 +713,8 @@ void gla2DSetMap(gla2DDrawInfo *di, rctf *rect) * * See glaDefine2DArea for an explanation of why this function uses integers. * - * \param screen_rect The screen rectangle to be used for 2D drawing. - * \param world_rect The world rectangle that the 2D area represented + * \param screen_rect: The screen rectangle to be used for 2D drawing. + * \param world_rect: The world rectangle that the 2D area represented * by \a screen_rect is supposed to represent. If NULL it is assumed the * world has a 1 to 1 mapping to the screen. */ diff --git a/source/blender/editors/sculpt_paint/sculpt.c b/source/blender/editors/sculpt_paint/sculpt.c index afee44c3dcc..c70aabb2d80 100644 --- a/source/blender/editors/sculpt_paint/sculpt.c +++ b/source/blender/editors/sculpt_paint/sculpt.c @@ -323,7 +323,7 @@ typedef struct SculptProjectVector { } SculptProjectVector; /** - * \param plane Direction, can be any length. + * \param plane: Direction, can be any length. */ static void sculpt_project_v3_cache_init( SculptProjectVector *spvc, const float plane[3]) diff --git a/source/blender/editors/space_file/fsmenu.h b/source/blender/editors/space_file/fsmenu.h index bb201a7a80c..e5a59e356eb 100644 --- a/source/blender/editors/space_file/fsmenu.h +++ b/source/blender/editors/space_file/fsmenu.h @@ -45,7 +45,7 @@ struct FSMenuEntry; /** Inserts a new fsmenu entry with the given \a path. * Duplicate entries are not added. - * \param flag Options for inserting the entry. + * \param flag: Options for inserting the entry. */ void fsmenu_insert_entry(struct FSMenu *fsmenu, enum FSMenuCategory category, const char *path, const char *name, const enum FSMenuInsert flag); diff --git a/source/blender/editors/space_image/image_ops.c b/source/blender/editors/space_image/image_ops.c index df303a7bf11..b6e51ab4655 100644 --- a/source/blender/editors/space_image/image_ops.c +++ b/source/blender/editors/space_image/image_ops.c @@ -1092,8 +1092,8 @@ static void image_open_cancel(bContext *UNUSED(C), wmOperator *op) /** * \brief Get a list of frames from the list of image files matching the first file name sequence pattern - * \param ptr [in] the RNA pointer containing the "directory" entry and "files" collection - * \param frames_all [out] the list of frame numbers found in the files matching the first one by name + * \param ptr: [in] the RNA pointer containing the "directory" entry and "files" collection + * \param frames_all: [out] the list of frame numbers found in the files matching the first one by name */ static void image_sequence_get_frame_ranges(PointerRNA *ptr, ListBase *frames_all) { diff --git a/source/blender/editors/space_node/node_edit.c b/source/blender/editors/space_node/node_edit.c index c1fd7aa120f..ad3a1a37f7a 100644 --- a/source/blender/editors/space_node/node_edit.c +++ b/source/blender/editors/space_node/node_edit.c @@ -257,7 +257,7 @@ static void compo_startjob(void *cjv, short *stop, short *do_update, float *prog } /** - * \param scene_owner is the owner of the job, + * \param scene_owner: is the owner of the job, * we don't use it for anything else currently so could also be a void pointer, * but for now keep it an 'Scene' for consistency. * diff --git a/source/blender/editors/space_text/text_format.c b/source/blender/editors/space_text/text_format.c index b64eefe969b..7a36b4f3e9c 100644 --- a/source/blender/editors/space_text/text_format.c +++ b/source/blender/editors/space_text/text_format.c @@ -144,7 +144,7 @@ int text_check_format_len(TextLine *line, unsigned int len) * Fill the string with formatting constant, * advancing \a str_p and \a fmt_p * - * \param len length in bytes of \a fmt_p to fill. + * \param len: length in bytes of \a fmt_p to fill. */ void text_format_fill(const char **str_p, char **fmt_p, const char type, const int len) { diff --git a/source/blender/editors/space_view3d/drawobject.c b/source/blender/editors/space_view3d/drawobject.c index c10f8f0ce16..dd174c7fd7a 100644 --- a/source/blender/editors/space_view3d/drawobject.c +++ b/source/blender/editors/space_view3d/drawobject.c @@ -411,7 +411,7 @@ static const float cosval[CIRCLE_RESOL] = { }; /** - * \param viewmat_local_unit is typically the 'rv3d->viewmatob' + * \param viewmat_local_unit: is typically the 'rv3d->viewmatob' * copied into a 3x3 matrix and normalized. */ static void draw_xyz_wire(const float viewmat_local_unit[3][3], const float c[3], float size, int axis) @@ -4337,7 +4337,7 @@ static bool draw_mesh_object(Scene *scene, ARegion *ar, View3D *v3d, RegionView3 /** - * \param dl_type_mask Only draw types matching this mask. + * \param dl_type_mask: Only draw types matching this mask. * \return true when nothing was drawn */ static bool drawDispListwire_ex(ListBase *dlbase, unsigned int dl_type_mask) @@ -7455,7 +7455,7 @@ static void draw_rigidbody_shape(Object *ob) /** * main object drawing function, draws in selection - * \param dflag (draw flag) can be DRAW_PICKING and/or DRAW_CONSTCOLOR, DRAW_SCENESET + * \param dflag: (draw flag) can be DRAW_PICKING and/or DRAW_CONSTCOLOR, DRAW_SCENESET */ void draw_object(Main *bmain, Scene *scene, ARegion *ar, View3D *v3d, Base *base, const short dflag) { diff --git a/source/blender/editors/space_view3d/view3d_camera_control.c b/source/blender/editors/space_view3d/view3d_camera_control.c index 31956ee5f86..5c544ed24df 100644 --- a/source/blender/editors/space_view3d/view3d_camera_control.c +++ b/source/blender/editors/space_view3d/view3d_camera_control.c @@ -281,7 +281,7 @@ void ED_view3d_cameracontrol_update( /** * Release view control. * - * \param restore Sets the view state to the values that were set + * \param restore: Sets the view state to the values that were set * before #ED_view3d_control_acquire was called. */ void ED_view3d_cameracontrol_release( diff --git a/source/blender/editors/space_view3d/view3d_edit.c b/source/blender/editors/space_view3d/view3d_edit.c index 679498ab16d..23c445ebc3e 100644 --- a/source/blender/editors/space_view3d/view3d_edit.c +++ b/source/blender/editors/space_view3d/view3d_edit.c @@ -1033,7 +1033,7 @@ static float view3d_ndof_pan_speed_calc(RegionView3D *rv3d) /** * Zoom and pan in the same function since sometimes zoom is interpreted as dolly (pan forward). * - * \param has_zoom zoom, otherwise dolly, often `!rv3d->is_persp` since it doesn't make sense to dolly in ortho. + * \param has_zoom: zoom, otherwise dolly, often `!rv3d->is_persp` since it doesn't make sense to dolly in ortho. */ static void view3d_ndof_pan_zoom( const struct wmNDOFMotionData *ndof, ScrArea *sa, ARegion *ar, diff --git a/source/blender/editors/space_view3d/view3d_project.c b/source/blender/editors/space_view3d/view3d_project.c index 3cc0857c8a7..20f3feb28ac 100644 --- a/source/blender/editors/space_view3d/view3d_project.c +++ b/source/blender/editors/space_view3d/view3d_project.c @@ -361,13 +361,13 @@ bool ED_view3d_clip_segment(const RegionView3D *rv3d, float ray_start[3], float * In orthographic view the resulting ray_normal will match the view vector. * This version also returns the ray_co point of the ray on window plane, useful to fix precision * issues esp. with ortho view, where default ray_start is set rather far away. - * \param ar The region (used for the window width and height). - * \param v3d The 3d viewport (used for near clipping value). - * \param mval The area relative 2d location (such as event->mval, converted into float[2]). - * \param r_ray_co The world-space point where the ray intersects the window plane. - * \param r_ray_normal The normalized world-space direction of towards mval. - * \param r_ray_start The world-space starting point of the ray. - * \param do_clip_planes Optionally clip the start of the ray by the view clipping planes. + * \param ar: The region (used for the window width and height). + * \param v3d: The 3d viewport (used for near clipping value). + * \param mval: The area relative 2d location (such as event->mval, converted into float[2]). + * \param r_ray_co: The world-space point where the ray intersects the window plane. + * \param r_ray_normal: The normalized world-space direction of towards mval. + * \param r_ray_start: The world-space starting point of the ray. + * \param do_clip_planes: Optionally clip the start of the ray by the view clipping planes. * \return success, false if the ray is totally clipped. */ bool ED_view3d_win_to_ray_clipped_ex( @@ -391,12 +391,12 @@ bool ED_view3d_win_to_ray_clipped_ex( * This ray_start is located at the viewpoint, ray_normal is the direction towards mval. * ray_start is clipped by the view near limit so points in front of it are always in view. * In orthographic view the resulting ray_normal will match the view vector. - * \param ar The region (used for the window width and height). - * \param v3d The 3d viewport (used for near clipping value). - * \param mval The area relative 2d location (such as event->mval, converted into float[2]). - * \param r_ray_start The world-space point where the ray intersects the window plane. - * \param r_ray_normal The normalized world-space direction of towards mval. - * \param do_clip_planes Optionally clip the start of the ray by the view clipping planes. + * \param ar: The region (used for the window width and height). + * \param v3d: The 3d viewport (used for near clipping value). + * \param mval: The area relative 2d location (such as event->mval, converted into float[2]). + * \param r_ray_start: The world-space point where the ray intersects the window plane. + * \param r_ray_normal: The normalized world-space direction of towards mval. + * \param do_clip_planes: Optionally clip the start of the ray by the view clipping planes. * \return success, false if the ray is totally clipped. */ bool ED_view3d_win_to_ray_clipped( @@ -409,10 +409,10 @@ bool ED_view3d_win_to_ray_clipped( /** * Calculate a 3d viewpoint and direction vector from 2d window coordinates. * This ray_start is located at the viewpoint, ray_normal is the direction towards mval. - * \param ar The region (used for the window width and height). - * \param mval The area relative 2d location (such as event->mval, converted into float[2]). - * \param r_ray_start The world-space point where the ray intersects the window plane. - * \param r_ray_normal The normalized world-space direction of towards mval. + * \param ar: The region (used for the window width and height). + * \param mval: The area relative 2d location (such as event->mval, converted into float[2]). + * \param r_ray_start: The world-space point where the ray intersects the window plane. + * \param r_ray_normal: The normalized world-space direction of towards mval. * * \note Ignores view near/far clipping, to take this into account use #ED_view3d_win_to_ray_clipped. */ @@ -427,9 +427,9 @@ void ED_view3d_win_to_ray( /** * Calculate a normalized 3d direction vector from the viewpoint towards a global location. * In orthographic view the resulting vector will match the view vector. - * \param rv3d The region (used for the window width and height). - * \param coord The world-space location. - * \param vec The resulting normalized vector. + * \param rv3d: The region (used for the window width and height). + * \param coord: The world-space location. + * \param vec: The resulting normalized vector. */ void ED_view3d_global_to_vector(const RegionView3D *rv3d, const float coord[3], float vec[3]) { @@ -489,10 +489,10 @@ bool view3d_get_view_aligned_coordinate(ARegion *ar, float fp[3], const int mval /** * Calculate a 3d location from 2d window coordinates. - * \param ar The region (used for the window width and height). - * \param depth_pt The reference location used to calculate the Z depth. - * \param mval The area relative location (such as event->mval converted to floats). - * \param r_out The resulting world-space location. + * \param ar: The region (used for the window width and height). + * \param depth_pt: The reference location used to calculate the Z depth. + * \param mval: The area relative location (such as event->mval converted to floats). + * \param r_out: The resulting world-space location. */ void ED_view3d_win_to_3d( const View3D *v3d, const ARegion *ar, @@ -584,9 +584,9 @@ bool ED_view3d_win_to_3d_on_plane_int( * Calculate a 3d difference vector from 2d window offset. * note that ED_view3d_calc_zfac() must be called first to determine * the depth used to calculate the delta. - * \param ar The region (used for the window width and height). - * \param mval The area relative 2d difference (such as event->mval[0] - other_x). - * \param out The resulting world-space delta. + * \param ar: The region (used for the window width and height). + * \param mval: The area relative 2d difference (such as event->mval[0] - other_x). + * \param out: The resulting world-space delta. */ void ED_view3d_win_to_delta(const ARegion *ar, const float mval[2], float out[3], const float zfac) { @@ -607,9 +607,9 @@ void ED_view3d_win_to_delta(const ARegion *ar, const float mval[2], float out[3] * Since far clip can be a very large value resulting in numeric precision issues, * the origin in this case is close to zero coordinate. * - * \param ar The region (used for the window width and height). - * \param mval The area relative 2d location (such as event->mval converted to floats). - * \param out The resulting normalized world-space direction vector. + * \param ar: The region (used for the window width and height). + * \param mval: The area relative 2d location (such as event->mval converted to floats). + * \param out: The resulting normalized world-space direction vector. */ void ED_view3d_win_to_origin(const ARegion *ar, const float mval[2], float out[3]) { @@ -641,9 +641,9 @@ void ED_view3d_win_to_origin(const ARegion *ar, const float mval[2], float out[3 * for perspective view, get the vector direction to * the mouse cursor as a normalized vector. * - * \param ar The region (used for the window width and height). - * \param mval The area relative 2d location (such as event->mval converted to floats). - * \param out The resulting normalized world-space direction vector. + * \param ar: The region (used for the window width and height). + * \param mval: The area relative 2d location (such as event->mval converted to floats). + * \param out: The resulting normalized world-space direction vector. */ void ED_view3d_win_to_vector(const ARegion *ar, const float mval[2], float out[3]) { @@ -668,12 +668,12 @@ void ED_view3d_win_to_vector(const ARegion *ar, const float mval[2], float out[3 * ray_start and ray_end are clipped by the view near and far limits * so points along this line are always in view. * In orthographic view all resulting segments will be parallel. - * \param ar The region (used for the window width and height). - * \param v3d The 3d viewport (used for near and far clipping range). - * \param mval The area relative 2d location (such as event->mval, converted into float[2]). - * \param r_ray_start The world-space starting point of the segment. - * \param r_ray_end The world-space end point of the segment. - * \param do_clip_planes Optionally clip the ray by the view clipping planes. + * \param ar: The region (used for the window width and height). + * \param v3d: The 3d viewport (used for near and far clipping range). + * \param mval: The area relative 2d location (such as event->mval, converted into float[2]). + * \param r_ray_start: The world-space starting point of the segment. + * \param r_ray_end: The world-space end point of the segment. + * \param do_clip_planes: Optionally clip the ray by the view clipping planes. * \return success, false if the segment is totally clipped. */ bool ED_view3d_win_to_segment_clipped( diff --git a/source/blender/editors/space_view3d/view3d_utils.c b/source/blender/editors/space_view3d/view3d_utils.c index 68582644f34..90da960ada8 100644 --- a/source/blender/editors/space_view3d/view3d_utils.c +++ b/source/blender/editors/space_view3d/view3d_utils.c @@ -1059,10 +1059,10 @@ float ED_view3d_radius_to_dist_ortho(const float lens, const float radius) * + * </pre> * - * \param ar Can be NULL if \a use_aspect is false. - * \param persp Allow the caller to tell what kind of perspective to use (ortho/view/camera) - * \param use_aspect Increase the distance to account for non 1:1 view aspect. - * \param radius The radius will be fitted exactly, typically pre-scaled by a margin (#VIEW3D_MARGIN). + * \param ar: Can be NULL if \a use_aspect is false. + * \param persp: Allow the caller to tell what kind of perspective to use (ortho/view/camera) + * \param use_aspect: Increase the distance to account for non 1:1 view aspect. + * \param radius: The radius will be fitted exactly, typically pre-scaled by a margin (#VIEW3D_MARGIN). */ float ED_view3d_radius_to_dist( const View3D *v3d, const ARegion *ar, @@ -1271,10 +1271,10 @@ bool ED_view3d_lock(RegionView3D *rv3d) /** * Set the view transformation from a 4x4 matrix. * - * \param mat The view 4x4 transformation matrix to assign. - * \param ofs The view offset, normally from RegionView3D.ofs. - * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * \param dist The view distance from ofs, normally from RegionView3D.dist. + * \param mat: The view 4x4 transformation matrix to assign. + * \param ofs: The view offset, normally from RegionView3D.ofs. + * \param quat: The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist: The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_from_m4(float mat[4][4], float ofs[3], float quat[4], float *dist) { @@ -1304,10 +1304,10 @@ void ED_view3d_from_m4(float mat[4][4], float ofs[3], float quat[4], float *dist /** * Calculate the view transformation matrix from RegionView3D input. * The resulting matrix is equivalent to RegionView3D.viewinv - * \param mat The view 4x4 transformation matrix to calculate. - * \param ofs The view offset, normally from RegionView3D.ofs. - * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * \param dist The view distance from ofs, normally from RegionView3D.dist. + * \param mat: The view 4x4 transformation matrix to calculate. + * \param ofs: The view offset, normally from RegionView3D.ofs. + * \param quat: The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist: The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_to_m4(float mat[4][4], const float ofs[3], const float quat[4], const float dist) { @@ -1321,11 +1321,11 @@ void ED_view3d_to_m4(float mat[4][4], const float ofs[3], const float quat[4], c /** * Set the RegionView3D members from an objects transformation and optionally lens. - * \param ob The object to set the view to. - * \param ofs The view offset to be set, normally from RegionView3D.ofs. - * \param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat. - * \param dist The view distance from ofs to be set, normally from RegionView3D.dist. - * \param lens The view lens angle set for cameras and lamps, normally from View3D.lens. + * \param ob: The object to set the view to. + * \param ofs: The view offset to be set, normally from RegionView3D.ofs. + * \param quat: The view rotation to be set, quaternion normally from RegionView3D.viewquat. + * \param dist: The view distance from ofs to be set, normally from RegionView3D.dist. + * \param lens: The view lens angle set for cameras and lamps, normally from View3D.lens. */ void ED_view3d_from_object(Object *ob, float ofs[3], float quat[4], float *dist, float *lens) { @@ -1342,10 +1342,10 @@ void ED_view3d_from_object(Object *ob, float ofs[3], float quat[4], float *dist, /** * Set the object transformation from RegionView3D members. - * \param ob The object which has the transformation assigned. - * \param ofs The view offset, normally from RegionView3D.ofs. - * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * \param dist The view distance from ofs, normally from RegionView3D.dist. + * \param ob: The object which has the transformation assigned. + * \param ofs: The view offset, normally from RegionView3D.ofs. + * \param quat: The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist: The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_to_object(Object *ob, const float ofs[3], const float quat[4], const float dist) { diff --git a/source/blender/editors/space_view3d/view3d_view.c b/source/blender/editors/space_view3d/view3d_view.c index 92f226f72de..cfd506caf6e 100644 --- a/source/blender/editors/space_view3d/view3d_view.c +++ b/source/blender/editors/space_view3d/view3d_view.c @@ -687,7 +687,7 @@ void VIEW3D_OT_object_as_camera(wmOperatorType *ot) * \{ */ /** - * \param rect optional for picking (can be NULL). + * \param rect: optional for picking (can be NULL). */ void view3d_winmatrix_set(ARegion *ar, const View3D *v3d, const rcti *rect) { diff --git a/source/blender/editors/space_view3d/view3d_walk.c b/source/blender/editors/space_view3d/view3d_walk.c index b81d84a1436..b2846a630d2 100644 --- a/source/blender/editors/space_view3d/view3d_walk.c +++ b/source/blender/editors/space_view3d/view3d_walk.c @@ -407,7 +407,7 @@ static void walk_navigation_mode_set(bContext *C, wmOperator *op, WalkInfo *walk } /** - * \param r_distance Distance to the hit point + * \param r_distance: Distance to the hit point */ static bool walk_floor_distance_get( RegionView3D *rv3d, WalkInfo *walk, const float dvec[3], @@ -441,9 +441,9 @@ static bool walk_floor_distance_get( } /** - * \param ray_distance Distance to the hit point - * \param r_location Location of the hit point - * \param r_normal Normal of the hit surface, transformed to always face the camera + * \param ray_distance: Distance to the hit point + * \param r_location: Location of the hit point + * \param r_normal: Normal of the hit surface, transformed to always face the camera */ static bool walk_ray_cast( RegionView3D *rv3d, WalkInfo *walk, diff --git a/source/blender/editors/transform/transform.c b/source/blender/editors/transform/transform.c index 3276c4af8fc..b5d0ece3057 100644 --- a/source/blender/editors/transform/transform.c +++ b/source/blender/editors/transform/transform.c @@ -5806,7 +5806,7 @@ static bool bm_loop_calc_opposite_co(BMLoop *l_tmp, * Given 2 edges and a loop, step over the loops * and calculate a direction to slide along. * - * \param r_slide_vec the direction to slide, + * \param r_slide_vec: the direction to slide, * the length of the vector defines the slide distance. */ static BMLoop *get_next_loop(BMVert *v, BMLoop *l, diff --git a/source/blender/editors/transform/transform_generics.c b/source/blender/editors/transform/transform_generics.c index 5e24a3d9e47..a56b74983e7 100644 --- a/source/blender/editors/transform/transform_generics.c +++ b/source/blender/editors/transform/transform_generics.c @@ -1789,7 +1789,7 @@ void calculateCenterBound(TransInfo *t, float r_center[3]) } /** - * \param select_only only get active center from data being transformed. + * \param select_only: only get active center from data being transformed. */ bool calculateCenterActive(TransInfo *t, bool select_only, float r_center[3]) { diff --git a/source/blender/editors/util/ed_util.c b/source/blender/editors/util/ed_util.c index 67b43814d40..b61960997b1 100644 --- a/source/blender/editors/util/ed_util.c +++ b/source/blender/editors/util/ed_util.c @@ -344,7 +344,7 @@ void ED_region_draw_mouse_line_cb(const bContext *C, ARegion *ar, void *arg_info /** * Use to free ID references within runtime data (stored outside of DNA) * - * \param new_id may be NULL to unlink \a old_id. + * \param new_id: may be NULL to unlink \a old_id. */ void ED_spacedata_id_remap(struct ScrArea *sa, struct SpaceLink *sl, ID *old_id, ID *new_id) { diff --git a/source/blender/freestyle/intern/image/GaussianFilter.h b/source/blender/freestyle/intern/image/GaussianFilter.h index f460d56e5a5..56baa3c3d46 100644 --- a/source/blender/freestyle/intern/image/GaussianFilter.h +++ b/source/blender/freestyle/intern/image/GaussianFilter.h @@ -65,16 +65,16 @@ public: /*! Returns the value for pixel x,y of image "map" after a gaussian blur, made using the sigma value. * The sigma value determines the mask size (~ 2 x sigma). - * \param map + * \param map: * The image we wish to work on. The Map template must implement the following methods: * - float pixel(unsigned int x,unsigned int y) const; * - unsigned width() const; * - unsigned height() const; - * \param x + * \param x: * The abscissa of the pixel where we want to evaluate the gaussian blur. - * \param y + * \param y: * The ordinate of the pixel where we want to evaluate the gaussian blur. - * \param sigma + * \param sigma: * The sigma value of the gaussian function. */ template<class Map> diff --git a/source/blender/freestyle/intern/image/Image.h b/source/blender/freestyle/intern/image/Image.h index 2e78e784214..c262da475d6 100644 --- a/source/blender/freestyle/intern/image/Image.h +++ b/source/blender/freestyle/intern/image/Image.h @@ -84,17 +84,17 @@ public: } /*! Builds a partial-storing image. - * \param w + * \param w: * The width of the complete image - * \param h + * \param h: * The height of the complete image - * \param sw + * \param sw: * The width of the rectangle that will actually be stored. - * \param sh + * \param sh: * The height of the rectangle that will actually be stored. - * \param ox + * \param ox: * The x-abscissa of the origin of the rectangle that will actually be stored. - * \param oy + * \param oy: * The x-abscissa of the origin of the rectangle that will actually be stored. */ FrsImage(unsigned w, unsigned h, unsigned sw, unsigned sh, unsigned ox, unsigned oy) @@ -138,22 +138,22 @@ public: virtual float pixel(unsigned x, unsigned y) const = 0; /*! Sets the array. - * \param array + * \param array: * The array containing the values we wish to store. * Its size is sw*sh. - * \param width + * \param width: * The width of the complete image - * \param height + * \param height: * The height of the complete image - * \param sw + * \param sw: * The width of the rectangle that will actually be stored. - * \param sh + * \param sh: * The height of the rectangle that will actually be stored. - * \param ox + * \param ox: * The x-abscissa of the origin of the rectangle that will actually be stored. - * \param oy + * \param oy: * The x-abscissa of the origin of the rectangle that will actually be stored. - * \param copy + * \param copy: * If true, the array is copied, otherwise the pointer is copied */ virtual void setArray(float *array, unsigned width, unsigned height, unsigned sw, unsigned sh, @@ -208,16 +208,16 @@ public: } /*! Builds an RGB partial image from the useful part buffer. - * \param rgb + * \param rgb: * The array of size 3*sw*sh containing the RGB values of the sw*sh pixels we need to stored. * These sw*sh pixels constitute a rectangular part of a bigger RGB image containing w*h pixels. - * \param w + * \param w: * The width of the complete image - * \param h + * \param h: * The height of the complete image - * \param sw + * \param sw: * The width of the part of the image we want to store and work on - * \param sh + * \param sh: * The height of the part of the image we want to store and work on */ RGBImage(float *rgb, unsigned w, unsigned h, unsigned sw, unsigned sh, unsigned ox, unsigned oy) @@ -341,16 +341,16 @@ public: } /*! Builds a partial image from the useful part buffer. - * \param lvl + * \param lvl: * The array of size sw*sh containing the gray values of the sw*sh pixels we need to stored. * These sw*sh pixels constitute a rectangular part of a bigger gray image containing w*h pixels. - * \param w + * \param w: * The width of the complete image - * \param h + * \param h: * The height of the complete image - * \param sw + * \param sw: * The width of the part of the image we want to store and work on - * \param sh + * \param sh: * The height of the part of the image we want to store and work on */ GrayImage(float *lvl, unsigned w, unsigned h, unsigned sw, unsigned sh, unsigned ox, unsigned oy) diff --git a/source/blender/freestyle/intern/image/ImagePyramid.h b/source/blender/freestyle/intern/image/ImagePyramid.h index 9a24ac6e1c8..fa55081646a 100644 --- a/source/blender/freestyle/intern/image/ImagePyramid.h +++ b/source/blender/freestyle/intern/image/ImagePyramid.h @@ -62,11 +62,11 @@ public: virtual GrayImage *getLevel(int l); /*! Returns the pixel x,y using bilinear interpolation. - * \param x + * \param x: * the abscissa specified in the finest level coordinate system - * \param y + * \param y: * the ordinate specified in the finest level coordinate system - * \param level + * \param level: * the level from which we want the pixel to be evaluated */ virtual float pixel(int x, int y, int level=0); diff --git a/source/blender/freestyle/intern/scene_graph/FrsMaterial.h b/source/blender/freestyle/intern/scene_graph/FrsMaterial.h index 220c966a5d0..48b0aabffb6 100644 --- a/source/blender/freestyle/intern/scene_graph/FrsMaterial.h +++ b/source/blender/freestyle/intern/scene_graph/FrsMaterial.h @@ -45,19 +45,19 @@ public: /*! Builds a Material from its line, diffuse, ambiant, specular, emissive * colors, a shininess coefficient and line color priority. - * \param iLine + * \param iLine: * A 4 element float-array containing the line color. - * \param iDiffuse + * \param iDiffuse: * A 4 element float-array containing the diffuse color. - * \param iAmbiant + * \param iAmbiant: * A 4 element float-array containing the ambiant color. - * \param iSpecular + * \param iSpecular: * A 4 element float-array containing the specular color. - * \param iEmission + * \param iEmission: * A 4 element float-array containing the emissive color. - * \param iShininess + * \param iShininess: * The shininess coefficient. - * \param iPriority + * \param iPriority: * The line color priority. */ inline FrsMaterial(const float *iLine, const float *iDiffuse, const float *iAmbiant, const float *iSpecular, @@ -232,73 +232,73 @@ public: } /*! Sets the line color. - * \param r + * \param r: * Red component - * \param g + * \param g: * Green component - * \param b + * \param b: * Blue component - * \param a + * \param a: * Alpha component */ inline void setLine(const float r, const float g, const float b, const float a); /*! Sets the diffuse color. - * \param r + * \param r: * Red component - * \param g + * \param g: * Green component - * \param b + * \param b: * Blue component - * \param a + * \param a: * Alpha component */ inline void setDiffuse(const float r, const float g, const float b, const float a); /*! Sets the specular color. - * \param r + * \param r: * Red component - * \param g + * \param g: * Green component - * \param b + * \param b: * Blue component - * \param a + * \param a: * Alpha component */ inline void setSpecular(const float r, const float g, const float b, const float a); /*! Sets the ambiant color. - * \param r + * \param r: * Red component - * \param g + * \param g: * Green component - * \param b + * \param b: * Blue component - * \param a + * \param a: * Alpha component */ inline void setAmbient(const float r, const float g, const float b, const float a); /*! Sets the emissive color. - * \param r + * \param r: * Red component - * \param g + * \param g: * Green component - * \param b + * \param b: * Blue component - * \param a + * \param a: * Alpha component */ inline void setEmission(const float r, const float g, const float b, const float a); /*! Sets the shininess. - * \param s + * \param s: * Shininess */ inline void setShininess(const float s); /*! Sets the line color priority. - * \param priority + * \param priority: * Priority */ inline void setPriority(const int priority); diff --git a/source/blender/freestyle/intern/scene_graph/NodeCamera.h b/source/blender/freestyle/intern/scene_graph/NodeCamera.h index 2fc6a00f955..b5021671873 100644 --- a/source/blender/freestyle/intern/scene_graph/NodeCamera.h +++ b/source/blender/freestyle/intern/scene_graph/NodeCamera.h @@ -181,7 +181,7 @@ public: * | zNear-zFar zNear-zFar | * | | * ( 0 0 -1 0 ) - * \param fovy + * \param fovy: * Field of View specified in radians. */ NodePerspectiveCamera(double fovy, double aspect, double zNear, double zFar); diff --git a/source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h b/source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h index 87f132b1ff3..f47808e6fc8 100644 --- a/source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h +++ b/source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h @@ -52,7 +52,7 @@ class DensityF0D : public UnaryFunction0D<double> { public: /*! Builds the functor from the gaussian sigma value. - * \param sigma + * \param sigma: * sigma indicates the x value for which the gaussian function is 0.5. It leads to the window size value. * (the larger, the smoother) */ @@ -111,9 +111,9 @@ private: public: /*! Builds the functor from name of the * Map that must be read. - * \param iMapName + * \param iMapName: * The name of the map. - * \param level + * \param level: * The level of the pyramid from which the pixel must be read. */ ReadMapPixelF0D(const char *iMapName, int level) : UnaryFunction0D<float>() @@ -142,9 +142,9 @@ private: public: /*! Builds the functor - * \param nOrientation + * \param nOrientation: * The integer belonging to [0,4] indicating the orientation (E,NE,N,NW) we are interested in. - * \param level + * \param level: * The level of the pyramid from which the pixel must be read. */ ReadSteerableViewMapPixelF0D(unsigned nOrientation, int level) : UnaryFunction0D<float>() @@ -172,7 +172,7 @@ private: public: /*! Builds the functor - * \param level + * \param level: * The level of the pyramid from which the pixel must be read. */ ReadCompleteViewMapPixelF0D(int level) : UnaryFunction0D<float>() @@ -200,7 +200,7 @@ private: public: /*! Builds the functor - * \param level + * \param level: * The level of the pyramid from which the pixel must be read. */ GetViewMapGradientNormF0D(int level) : UnaryFunction0D<float>() diff --git a/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h b/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h index ec698ca5e68..6624d9d255c 100644 --- a/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h +++ b/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h @@ -54,11 +54,11 @@ private: public: /*! Builds the functor. - * \param sigma + * \param sigma: * Thesigma used in DensityF0D and determining the window size used in each density query. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. - * \param sampling + * \param sampling: * The resolution used to sample the chain: the corresponding 0D function is evaluated at each sample point and * the result is obtained by combining the resulting values into a single one, following the method specified * by iType. @@ -98,9 +98,9 @@ class LocalAverageDepthF1D : public UnaryFunction1D<double> { public: /*! Builds the functor. - * \param sigma + * \param sigma: * The sigma used in DensityF0D and determining the window size used in each density query. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ LocalAverageDepthF1D(real sigma, IntegrationType iType = MEAN) @@ -134,13 +134,13 @@ class GetCompleteViewMapDensityF1D : public UnaryFunction1D<double> { public: /*! Builds the functor. - * \param level + * \param level: * The level of the pyramid from which * the pixel must be read. - * \param iType + * \param iType: * The integration method used to compute * a single value from a set of values. - * \param sampling + * \param sampling: * The resolution used to sample the chain: the corresponding 0D function * is evaluated at each sample point and the result is obtained by * combining the resulting values into a single one, following the @@ -176,13 +176,13 @@ class GetDirectionalViewMapDensityF1D : public UnaryFunction1D<double> { public: /*! Builds the functor. - * \param iOrientation + * \param iOrientation: * The number of the directional map we must work with. - * \param level + * \param level: * The level of the pyramid from which the pixel must be read. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. - * \param sampling + * \param sampling: * The resolution used to sample the chain: the corresponding 0D function is evaluated at each sample point and * the result is obtained by combining the resulting values into a single one, following the method specified * by iType. @@ -220,11 +220,11 @@ private: public: /*! Builds the functor from the level of the pyramid from which the pixel must be read. - * \param level + * \param level: * The level of the pyramid from which the pixel must be read. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. - * \param sampling + * \param sampling: * The resolution used to sample the chain: the corresponding 0D function is evaluated at each sample point and * the result is obtained by combining the resulting values into a single one, following the method specified * by iType. @@ -262,11 +262,11 @@ private: public: /*! Builds the functor from the level of the pyramid from which the pixel must be read. - * \param level + * \param level: * The level of the pyramid from which the pixel must be read. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. - * \param sampling + * \param sampling: * The resolution used to sample the chain: the corresponding 0D function is evaluated at each sample point and * the result is obtained by combining the resulting values into a single one, following the method specified * by iType. diff --git a/source/blender/freestyle/intern/stroke/AdvancedPredicates1D.h b/source/blender/freestyle/intern/stroke/AdvancedPredicates1D.h index c65f121e9ba..5fcabfe9e0e 100644 --- a/source/blender/freestyle/intern/stroke/AdvancedPredicates1D.h +++ b/source/blender/freestyle/intern/stroke/AdvancedPredicates1D.h @@ -52,10 +52,10 @@ class DensityLowerThanUP1D : public UnaryPredicate1D { public: /*! Builds the functor. - * \param threshold + * \param threshold: * The value of the threshold density. * Any Interface1D having a density lower than this threshold will match. - * \param sigma + * \param sigma: * The sigma value defining the density evaluation window size used in the DensityF0D functor. */ DensityLowerThanUP1D(double threshold, double sigma = 2) diff --git a/source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h b/source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h index 50b55027de7..c3498003317 100644 --- a/source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h +++ b/source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h @@ -41,13 +41,13 @@ class CalligraphicShader : public StrokeShader { public: /*! Builds the shader. - * \param iMinThickness + * \param iMinThickness: * The minimum thickness in the direction perpandicular to the main direction. - * \param iMaxThickness + * \param iMaxThickness: * The maximum thickness in the main direction. - * \param iOrientation + * \param iOrientation: * The 2D vector giving the main direction. - * \param clamp + * \param clamp: * Tells ??? */ CalligraphicShader(real iMinThickness, real iMaxThickness, const Vec2f &iOrientation, bool clamp); @@ -74,15 +74,15 @@ class SpatialNoiseShader : public StrokeShader { public: /*! Builds the shader. - * \param iAmount + * \param iAmount: * The amplitude of the noise. - * \param ixScale + * \param ixScale: * The noise frequency - * \param nbOctave + * \param nbOctave: * The number of octaves - * \param smooth + * \param smooth: * If you want the noise to be smooth - * \param pureRandom + * \param pureRandom: * If you don't want any coherence */ SpatialNoiseShader(float iAmount, float ixScale, int nbOctave, bool smooth, bool pureRandom); @@ -112,21 +112,21 @@ class SmoothingShader : public StrokeShader { public: /*! Builds the shader. - * \param iNbIteration + * \param iNbIteration: * The number of iterations. (400) - * \param iFactorPoint + * \param iFactorPoint: * 0 - * \param ifactorCurvature + * \param ifactorCurvature: * 0 - * \param iFactorCurvatureDifference + * \param iFactorCurvatureDifference: * 0.2 - * \param iAnisoPoint + * \param iAnisoPoint: * 0 - * \param iAnisNormal + * \param iAnisNormal: * 0 - * \param iAnisoCurvature + * \param iAnisoCurvature: * 0 - * \param icarricatureFactor + * \param icarricatureFactor: * 1 */ SmoothingShader(int iNbIteration, real iFactorPoint, real ifactorCurvature, real iFactorCurvatureDifference, diff --git a/source/blender/freestyle/intern/stroke/BasicStrokeShaders.h b/source/blender/freestyle/intern/stroke/BasicStrokeShaders.h index 1cdc754d725..53e0d5b7175 100644 --- a/source/blender/freestyle/intern/stroke/BasicStrokeShaders.h +++ b/source/blender/freestyle/intern/stroke/BasicStrokeShaders.h @@ -61,7 +61,7 @@ class ConstantThicknessShader : public StrokeShader { public: /*! Builds the shader. - * \param thickness + * \param thickness: * The thickness that must be assigned to the stroke. */ ConstantThicknessShader(float thickness) : StrokeShader() @@ -121,9 +121,9 @@ class IncreasingThicknessShader : public StrokeShader { public: /*! Builds the shader. - * \param iThicknessMin + * \param iThicknessMin: * The first thickness value. - * \param iThicknessMax + * \param iThicknessMax: * The second thickness value. */ IncreasingThicknessShader(float iThicknessMin, float iThicknessMax) : StrokeShader() @@ -161,11 +161,11 @@ private: public: /*! Builds the shader. - * \param iThicknessMin + * \param iThicknessMin: * The first thickness value. - * \param iThicknessMax + * \param iThicknessMax: * The second thickness value. - * \param iRatio + * \param iRatio: * The ration thickness/length we don't want to exceed. */ ConstrainedIncreasingThicknessShader(float iThicknessMin, float iThicknessMax, float iRatio) : StrokeShader() @@ -233,9 +233,9 @@ public: ThicknessNoiseShader(); /*! Builds a Thickness Noise Shader - * \param iAmplitude + * \param iAmplitude: * The amplitude of the noise signal - * \param iPeriod + * \param iPeriod: * The period of the noise signal */ ThicknessNoiseShader(float iAmplitude, float iPeriod); @@ -261,13 +261,13 @@ class ConstantColorShader : public StrokeShader { public: /*! Builds the shader from a user-specified color. - * \param iR + * \param iR: * The red component - * \param iG + * \param iG: * The green component - * \param iB + * \param iB: * The blue component - * \param iAlpha + * \param iAlpha: * The alpha value */ ConstantColorShader(float iR, float iG, float iB, float iAlpha = 1.0f) : StrokeShader() @@ -303,21 +303,21 @@ private: public: /*! Builds the shader from 2 user-specified colors. - * \param iRm + * \param iRm: * The first color red component - * \param iGm + * \param iGm: * The first color green component - * \param iBm + * \param iBm: * The first color blue component - * \param iAlpham + * \param iAlpham: * The first color alpha value - * \param iRM + * \param iRM: * The second color red component - * \param iGM + * \param iGM: * The second color green component - * \param iBM + * \param iBM: * The second color blue component - * \param iAlphaM + * \param iAlphaM: * The second color alpha value */ IncreasingColorShader(float iRm, float iGm, float iBm, float iAlpham, @@ -379,9 +379,9 @@ public: ColorNoiseShader(); /*! Builds a Color Noise Shader - * \param iAmplitude + * \param iAmplitude: * The amplitude of the noise signal - * \param iPeriod + * \param iPeriod: * The period of the noise signal */ ColorNoiseShader(float iAmplitude, float iPeriod); @@ -409,7 +409,7 @@ private: public: /*! Builds the shader. - * \param iAmount + * \param iAmount: * The stretching amount value. */ BackboneStretcherShader(float iAmount = 2.0f) : StrokeShader() @@ -437,7 +437,7 @@ private: public: /*! Builds the shader. - * \param sampling + * \param sampling: * The sampling to use for the stroke resampling */ SamplingShader(float sampling) : StrokeShader() @@ -488,7 +488,7 @@ private: public: /*! Builds the shader. - * \param error + * \param error: * The error we're allowing for the approximation. * This error is the max distance allowed between the new curve and the original geometry. */ @@ -519,7 +519,7 @@ private: public: /*! Builds the shader. - * \param iError + * \param iError: * The error we want our polygonal approximation to have with respect to the original geometry. * The smaller, the closer the new stroke to the orinal one. * This error corresponds to the maximum distance between the new stroke and the old one. @@ -552,7 +552,7 @@ private: public: /*! Builds a Guiding Lines shader - * \param iOffset + * \param iOffset: * The line that replaces the stroke is initially in the middle of the initial stroke "bbox". * iOffset is the value of the displacement which is applied to this line along its normal. */ @@ -577,7 +577,7 @@ class TipRemoverShader : public StrokeShader { public: /*! Builds the shader. - * \param tipLength + * \param tipLength: * The length of the piece of stroke we want to remove at each extremity. */ TipRemoverShader (real tipLength); @@ -609,7 +609,7 @@ private: public: /*! Builds the shader. - * \param mtex + * \param mtex: * The blender texture to use. */ BlenderTextureShader(MTex *mtex) : StrokeShader() @@ -619,7 +619,7 @@ public: } /*! Builds the shader. - * \param nodetree + * \param nodetree: * A node tree (of new shading nodes) to define textures. */ BlenderTextureShader(bNodeTree *nodetree) : StrokeShader() @@ -648,7 +648,7 @@ private: public: /*! Builds the shader. - * \param id + * \param id: * The number of the preset to use. */ StrokeTextureStepShader(float step) : StrokeShader() diff --git a/source/blender/freestyle/intern/stroke/Canvas.h b/source/blender/freestyle/intern/stroke/Canvas.h index 6d84ff995d2..7151a81cce2 100644 --- a/source/blender/freestyle/intern/stroke/Canvas.h +++ b/source/blender/freestyle/intern/stroke/Canvas.h @@ -148,11 +148,11 @@ public: /*! Loads an image map. The map will be scaled (without preserving the ratio in order to fit the actual * canvas size.). * The image must be a gray values image... - * \param iFileName + * \param iFileName: * The name of the image file - * \param iMapName + * \param iMapName: * The name that will be used to access this image - * \param iNbLevels + * \param iNbLevels: * The number of levels in the map pyramid. (default = 4). * If iNbLevels == 0, the complete pyramid is built. */ @@ -160,13 +160,13 @@ public: /*! Reads a pixel value in a map. * Returns a value between 0 and 1. - * \param iMapName + * \param iMapName: * The name of the map - * \param level + * \param level: * The level of the pyramid from which the pixel must be read. - * \param x + * \param x: * The abscissa of the desired pixel specified in level0 coordinate system. The origin is the lower left corner. - * \param y + * \param y: * The ordinate of the desired pixel specified in level0 coordinate system. The origin is the lower left corner. */ float readMapPixel(const char *iMapName, int level, int x, int y); diff --git a/source/blender/freestyle/intern/stroke/Chain.h b/source/blender/freestyle/intern/stroke/Chain.h index 6cf3a7199bf..ec1250445fa 100644 --- a/source/blender/freestyle/intern/stroke/Chain.h +++ b/source/blender/freestyle/intern/stroke/Chain.h @@ -82,17 +82,17 @@ public: } /*! Adds a ViewEdge at the end of the chain - * \param iViewEdge + * \param iViewEdge: * The ViewEdge that must be added. - * \param orientation + * \param orientation: * The orientation with which this ViewEdge must be processed. */ void push_viewedge_back(ViewEdge *iViewEdge, bool orientation); /*! Adds a ViewEdge at the beginning of the chain - * \param iViewEdge + * \param iViewEdge: * The ViewEdge that must be added. - * \param orientation + * \param orientation: * The orientation with which this ViewEdge must be processed. */ void push_viewedge_front(ViewEdge *iViewEdge, bool orientation); diff --git a/source/blender/freestyle/intern/stroke/ChainingIterators.h b/source/blender/freestyle/intern/stroke/ChainingIterators.h index 310409f160f..a50a6596f96 100644 --- a/source/blender/freestyle/intern/stroke/ChainingIterators.h +++ b/source/blender/freestyle/intern/stroke/ChainingIterators.h @@ -162,13 +162,13 @@ public: void *py_c_it; /*! Builds a Chaining Iterator from the first ViewEdge used for iteration and its orientation. - * \param iRestrictToSelection + * \param iRestrictToSelection: * Indicates whether to force the chaining to stay within the set of selected ViewEdges or not. - * \param iRestrictToUnvisited + * \param iRestrictToUnvisited: * Indicates whether a ViewEdge that has already been chained must be ignored ot not. - * \param begin + * \param begin: * The ViewEdge from which to start the chain. - * \param orientation + * \param orientation: * The direction to follow to explore the graph. If true, the direction indicated by the first ViewEdge is used. */ ChainingIterator(bool iRestrictToSelection = true, bool iRestrictToUnvisited = true, ViewEdge *begin = NULL, @@ -205,7 +205,7 @@ public: /*! This method iterates over the potential next ViewEdges and returns the one that will be followed next. * returns the next ViewEdge to follow or 0 when the end of the chain is reached. - * \param it + * \param it: * The iterator over the ViewEdges adjacent to the end vertex of the current ViewEdge. * The Adjacency iterator reflects the restriction rules by only iterating over the valid ViewEdges. */ @@ -262,11 +262,11 @@ class ChainSilhouetteIterator : public ChainingIterator { public: /*! Builds a ChainSilhouetteIterator from the first ViewEdge used for iteration and its orientation. - * \param iRestrictToSelection + * \param iRestrictToSelection: * Indicates whether to force the chaining to stay within the set of selected ViewEdges or not. - * \param begin + * \param begin: * The ViewEdge from where to start the iteration. - * \param orientation + * \param orientation: * If true, we'll look for the next ViewEdge among the ViewEdges that surround the ending ViewVertex of begin. * If false, we'll search over the ViewEdges surrounding the ending ViewVertex of begin. */ @@ -317,13 +317,13 @@ protected: public: /*! Builds a ChainPredicateIterator from a starting ViewEdge and its orientation. - * \param iRestrictToSelection + * \param iRestrictToSelection: * Indicates whether to force the chaining to stay within the set of selected ViewEdges or not. - * \param iRestrictToUnvisited + * \param iRestrictToUnvisited: * Indicates whether a ViewEdge that has already been chained must be ignored ot not. - * \param begin + * \param begin: * The ViewEdge from where to start the iteration. - * \param orientation + * \param orientation: * If true, we'll look for the next ViewEdge among the ViewEdges that surround the ending ViewVertex of begin. * If false, we'll search over the ViewEdges surrounding the ending ViewVertex of begin. */ @@ -337,17 +337,17 @@ public: /*! Builds a ChainPredicateIterator from a unary predicate, a binary predicate, a starting ViewEdge and * its orientation. - * \param iRestrictToSelection + * \param iRestrictToSelection: * Indicates whether to force the chaining to stay within the set of selected ViewEdges or not. - * \param iRestrictToUnvisited + * \param iRestrictToUnvisited: * Indicates whether a ViewEdge that has already been chained must be ignored ot not. - * \param upred + * \param upred: * The unary predicate that the next ViewEdge must satisfy. - * \param bpred + * \param bpred: * The binary predicate that the next ViewEdge must satisfy together with the actual pointed ViewEdge. - * \param begin + * \param begin: * The ViewEdge from where to start the iteration. - * \param orientation + * \param orientation: * If true, we'll look for the next ViewEdge among the ViewEdges that surround the ending ViewVertex of begin. * If false, we'll search over the ViewEdges surrounding the ending ViewVertex of begin. */ diff --git a/source/blender/freestyle/intern/stroke/ContextFunctions.h b/source/blender/freestyle/intern/stroke/ContextFunctions.h index 97710437e47..58953d021d9 100644 --- a/source/blender/freestyle/intern/stroke/ContextFunctions.h +++ b/source/blender/freestyle/intern/stroke/ContextFunctions.h @@ -66,13 +66,13 @@ void LoadMapCF(const char *iFileName, const char *iMapName, unsigned iNbLevels = // ReadMapPixel /*! Reads a pixel in a user-defined map * \return the floating value stored for that pixel - * \param iMapName + * \param iMapName: * The name of the map - * \param level + * \param level: * The level of the pyramid in which we wish to read the pixel - * \param x + * \param x: * The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner. - * \param y + * \param y: * The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner. */ float ReadMapPixelCF(const char *iMapName, int level, unsigned x, unsigned y); @@ -80,11 +80,11 @@ float ReadMapPixelCF(const char *iMapName, int level, unsigned x, unsigned y); // ReadCompleteViewMapPixel /*! Reads a pixel in the complete view map * \return the floating value stored for that pixel - * \param level + * \param level: * The level of the pyramid in which we wish to read the pixel - * \param x + * \param x: * The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner. - * \param y + * \param y: * The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner. */ float ReadCompleteViewMapPixelCF(int level, unsigned x, unsigned y); @@ -92,13 +92,13 @@ float ReadCompleteViewMapPixelCF(int level, unsigned x, unsigned y); // ReadOrientedViewMapPixel /*! Reads a pixel in one of the oriented view map images * \return the floating value stored for that pixel - * \param iOrientation + * \param iOrientation: * The number telling which orientation we want to check - * \param level + * \param level: * The level of the pyramid in which we wish to read the pixel - * \param x + * \param x: * The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner. - * \param y + * \param y: * The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner. */ float ReadDirectionalViewMapPixelCF(int iOrientation, int level, unsigned x, unsigned y); diff --git a/source/blender/freestyle/intern/stroke/Curve.h b/source/blender/freestyle/intern/stroke/Curve.h index 04cc2fbfd39..1b242d172b2 100644 --- a/source/blender/freestyle/intern/stroke/Curve.h +++ b/source/blender/freestyle/intern/stroke/Curve.h @@ -204,21 +204,21 @@ public: CurvePoint(); /*! Builds a CurvePoint from two SVertex and an interpolation parameter. - * \param iA + * \param iA: * The first SVertex - * \param iB + * \param iB: * The second SVertex - * \param t2d + * \param t2d: * A 2D interpolation parameter used to linearly interpolate \a iA and \a iB */ CurvePoint(SVertex *iA, SVertex *iB, float t2d); /*! Builds a CurvePoint from two CurvePoint and an interpolation parameter. - * \param iA + * \param iA: * The first CurvePoint - * \param iB + * \param iB: * The second CurvePoint - * \param t2d + * \param t2d: * The 2D interpolation parameter used to linearly interpolate \a iA and \a iB. */ CurvePoint(CurvePoint *iA, CurvePoint *iB, float t2d); diff --git a/source/blender/freestyle/intern/stroke/Operators.h b/source/blender/freestyle/intern/stroke/Operators.h index 4130f9b370e..b364d5a36b4 100644 --- a/source/blender/freestyle/intern/stroke/Operators.h +++ b/source/blender/freestyle/intern/stroke/Operators.h @@ -65,7 +65,7 @@ public: //////////////////////////////////////////////// /*! Selects the ViewEdges of the ViewMap verifying a specified condition. - * \param pred The predicate expressing this condition + * \param pred: The predicate expressing this condition */ static int select(UnaryPredicate1D& pred); @@ -73,11 +73,11 @@ public: * Each ViewEdge of the current list starts a new chain. The chaining operator then iterates over the ViewEdges * of the ViewMap using the user specified iterator. * This operator only iterates using the increment operator and is therefore unidirectional. - * \param it + * \param it: * The iterator on the ViewEdges of the ViewMap. It contains the chaining rule. - * \param pred + * \param pred: * The predicate on the ViewEdge that expresses the stopping condition. - * \param modifier + * \param modifier: * A function that takes a ViewEdge as argument and that is used to modify the processed ViewEdge * state (the timestamp incrementation is a typical illustration of such a modifier) */ @@ -89,9 +89,9 @@ public: * This operator only iterates using the increment operator and is therefore unidirectional. * This chaining operator is different from the previous one because it doesn't take any modifier as argument. * Indeed, the time stamp (insuring that a ViewEdge is processed one time) is automatically managed in this case. - * \param it + * \param it: * The iterator on the ViewEdges of the ViewMap. It contains the chaining rule. - * \param pred + * \param pred: * The predicate on the ViewEdge that expresses the stopping condition. */ static int chain(ViewEdgeInternal::ViewEdgeIterator& it, UnaryPredicate1D& pred); @@ -104,9 +104,9 @@ public: * be told to chain only edges that belong to the selection or not to process twice a ViewEdge during the chaining. * Each time a ViewEdge is added to a chain, its chaining time stamp is incremented. This allows you to keep track * of the number of chains to which a ViewEdge belongs to. - * \param it + * \param it: * The ChainingIterator on the ViewEdges of the ViewMap. It contains the chaining rule. - * \param pred + * \param pred: * The predicate on the ViewEdge that expresses the stopping condition. */ static int bidirectionalChain(ChainingIterator& it, UnaryPredicate1D& pred); @@ -121,7 +121,7 @@ public: * told to chain only edges that belong to the selection or not to process twice a ViewEdge during the chaining. * Each time a ViewEdge is added to a chain, its chaining time stamp is incremented. This allows you to keep track * of the number of chains to which a ViewEdge belongs to. - * \param it + * \param it: * The ChainingIterator on the ViewEdges of the ViewMap. It contains the chaining rule. */ static int bidirectionalChain(ChainingIterator& it); @@ -133,11 +133,11 @@ public: * This allows chains overlapping rather than chains partitioning. * The first point of the initial chain is the first point of one of the resulting chains. * The splitting ends when no more chain can start. - * \param startingPred + * \param startingPred: * The predicate on a point that expresses the starting condition - * \param stoppingPred + * \param stoppingPred: * The predicate on a point that expresses the stopping condition - * \param sampling + * \param sampling: * The resolution used to sample the chain for the predicates evaluation. (The chain is not actually * resampled, a virtual point only progresses along the curve using this resolution) */ @@ -147,9 +147,9 @@ public: * The points of each chain are processed (with a specified sampling) sequentially and each time a user * specified condition is verified, the chain is split into two chains. * The resulting set of chains is a partition of the initial chain - * \param pred + * \param pred: * The predicate on a point that expresses the splitting condition - * \param sampling + * \param sampling: * The resolution used to sample the chain for the predicate evaluation. (The chain is not actually * resampled, a virtual point only progresses along the curve using this resolution) */ @@ -160,14 +160,14 @@ public: * function. The chain is split in two at this point and the two new chains are processed in the same way. * The recursivity level is controlled through a predicate 1D that expresses a stopping condition * on the chain that is about to be processed. - * \param func + * \param func: * The Unary Function evaluated at each point of the chain. * The splitting point is the point minimizing this function - * \param pred + * \param pred: * The Unary Predicate ex pressing the recursivity stopping condition. * This predicate is evaluated for each curve before it actually gets split. * If pred(chain) is true, the curve won't be split anymore. - * \param sampling + * \param sampling: * The resolution used to sample the chain for the predicates evaluation. (The chain is not actually * resampled, a virtual point only progresses along the curve using this resolution) */ @@ -180,19 +180,19 @@ public: * A point that doesn't verify the 0D predicate won't be candidate in realizing the min. * The recursivity level is controlled through a predicate 1D that expresses a stopping condition * on the chain that is about to be processed. - * \param func + * \param func: * The Unary Function evaluated at each point of the chain. * The splitting point is the point minimizing this function - * \param pred0d + * \param pred0d: * The Unary Predicate 0D used to select the candidate points where the split can occur. * For example, it is very likely that would rather have your chain splitting around its middle point * than around one of its extremities. A 0D predicate working on the curvilinear abscissa allows * to add this kind of constraints. - * \param pred + * \param pred: * The Unary Predicate ex pressing the recursivity stopping condition. * This predicate is evaluated for each curve before it actually gets split. * If pred(chain) is true, the curve won't be split anymore. - * \param sampling + * \param sampling: * The resolution used to sample the chain for the predicates evaluation. (The chain is not actually * resampled, a virtual point only progresses along the curve using this resolution) */ @@ -200,16 +200,16 @@ public: float sampling = 0.0f); /*! Sorts the current set of chains (or viewedges) according to the comparison predicate given as argument. - * \param pred + * \param pred: * The binary predicate used for the comparison */ static int sort(BinaryPredicate1D& pred); /*! Creates and shades the strokes from the current set of chains. * A predicate can be specified to make a selection pass on the chains. - * \param pred + * \param pred: * The predicate that a chain must verify in order to be transform as a stroke - * \param shaders + * \param shaders: * The list of shaders used to shade the strokes */ static int create(UnaryPredicate1D& pred, vector<StrokeShader*> shaders); diff --git a/source/blender/freestyle/intern/stroke/Predicates0D.h b/source/blender/freestyle/intern/stroke/Predicates0D.h index 6ce77649c31..bf09d99bcbd 100644 --- a/source/blender/freestyle/intern/stroke/Predicates0D.h +++ b/source/blender/freestyle/intern/stroke/Predicates0D.h @@ -70,7 +70,7 @@ public: } /*! The () operator. Must be overload by inherited classes. - * \param it + * \param it: * The Interface0DIterator pointing onto the Interface0D at which we wish to evaluate the predicate. * \return true if the condition is satisfied, false otherwise. */ @@ -115,9 +115,9 @@ public: /*! The () operator. Must be overload by inherited classes. * It evaluates a relation between 2 Interface0D. - * \param inter1 + * \param inter1: * The first Interface0D. - * \param inter2 + * \param inter2: * The second Interface0D. * \return true or false. */ diff --git a/source/blender/freestyle/intern/stroke/Predicates1D.h b/source/blender/freestyle/intern/stroke/Predicates1D.h index 05fc043822f..9f8b264abcd 100644 --- a/source/blender/freestyle/intern/stroke/Predicates1D.h +++ b/source/blender/freestyle/intern/stroke/Predicates1D.h @@ -77,7 +77,7 @@ public: } /*! The () operator. Must be overload by inherited classes. - * \param inter + * \param inter: * The Interface1D on which we wish to evaluate the predicate. * \return true if the condition is satisfied, false otherwise. */ @@ -122,9 +122,9 @@ public: /*! The () operator. Must be overload by inherited classes. * It evaluates a relation between 2 Interface1D. - * \param inter1 + * \param inter1: * The first Interface1D. - * \param inter2 + * \param inter2: * The second Interface1D. * \return true or false. */ @@ -195,7 +195,7 @@ class QuantitativeInvisibilityUP1D : public UnaryPredicate1D { public: /*! Builds the Predicate. - * \param qi + * \param qi: * The Quantitative Invisibility you want the Interface1D to have */ QuantitativeInvisibilityUP1D(unsigned qi = 0) : _qi(qi) {} @@ -359,9 +359,9 @@ private: public: /*! Builds the Predicate. - * \param idFirst + * \param idFirst: * The first Id component. - * \param idSecond + * \param idSecond: * The second Id component. */ ShapeUP1D(unsigned idFirst, unsigned idSecond = 0) : UnaryPredicate1D() @@ -400,13 +400,13 @@ private: public: /*! Builds the Predicate. - * \param xmin + * \param xmin: * The X lower bound of the image boundary. - * \param ymin + * \param ymin: * The Y lower bound of the image boundary. - * \param xmax + * \param xmax: * The X upper bound of the image boundary. - * \param ymax + * \param ymax: * The Y upper bound of the image boundary. */ WithinImageBoundaryUP1D(const real xmin, const real ymin, const real xmax, const real ymax) diff --git a/source/blender/freestyle/intern/stroke/Stroke.h b/source/blender/freestyle/intern/stroke/Stroke.h index ce63c528ac3..6ef92db99fc 100644 --- a/source/blender/freestyle/intern/stroke/Stroke.h +++ b/source/blender/freestyle/intern/stroke/Stroke.h @@ -73,28 +73,28 @@ public: StrokeAttribute(const StrokeAttribute& iBrother); /*! Builds a stroke vertex attribute from a set of parameters. - * \param iRColor + * \param iRColor: * The Red Component value. - * \param iGColor + * \param iGColor: * The Green Component value. - * \param iBColor + * \param iBColor: * The Blue Component value. - * \param iAlpha + * \param iAlpha: * The transparency value - * \param iRThickness + * \param iRThickness: * The thickness of the stroke on the right - * \param iLThickness + * \param iLThickness: * The Thickness of the stroke on the left */ StrokeAttribute(float iRColor, float iGColor, float iBColor, float iAlpha, float iRThickness, float iLThickness); /*! Interpolation constructor. * Builds a StrokeAttribute from two StrokeAttributes and an interpolation parameter. - * \param a1 + * \param a1: * The first Attribute. - * \param a2 + * \param a2: * The second parameter. - * \param t + * \param t: * The interpolation parameter. */ StrokeAttribute(const StrokeAttribute& a1, const StrokeAttribute& a2, float t); @@ -179,19 +179,19 @@ public: } /*! Returns an attribute of type real - * \param iName + * \param iName: * The name of the attribute */ float getAttributeReal(const char *iName) const; /*! Returns an attribute of type Vec2f - * \param iName + * \param iName: * The name of the attribute */ Vec2f getAttributeVec2f(const char *iName) const; /*! Returns an attribute of type Vec3f - * \param iName + * \param iName: * The name of the attribute */ Vec3f getAttributeVec3f(const char *iName) const; @@ -207,11 +207,11 @@ public: /* modifiers */ /*! sets the attribute's color. - * \param r + * \param r: * The new R value. - * \param g + * \param g: * The new G value. - * \param b + * \param b: * The new B value. */ inline void setColor(float r, float g, float b) @@ -222,7 +222,7 @@ public: } /*! sets the attribute's color. - * \param iRGB + * \param iRGB: * The new RGB values. */ inline void setColor(const Vec3f& iRGB) @@ -233,7 +233,7 @@ public: } /*! sets the attribute's alpha value. - * \param alpha + * \param alpha: * The new alpha value. */ inline void setAlpha(float alpha) @@ -242,9 +242,9 @@ public: } /*! sets the attribute's thickness. - * \param tr + * \param tr: * The thickness on the right of the vertex when following the stroke. - * \param tl + * \param tl: * The thickness on the left of the vertex when following the stroke. */ inline void setThickness(float tr, float tl) @@ -254,7 +254,7 @@ public: } /*! sets the attribute's thickness. - * \param tRL + * \param tRL: * The thickness on the right and on the left of the vertex when following the stroke. */ inline void setThickness(const Vec2f& tRL) @@ -272,9 +272,9 @@ public: /*! Adds a user defined attribute of type real * If there is no attribute of name iName, it is added. * Otherwise, the new value replaces the old one. - * \param iName + * \param iName: * The name of the attribute - * \param att + * \param att: * The attribute's value */ void setAttributeReal(const char *iName, float att); @@ -282,9 +282,9 @@ public: /*! Adds a user defined attribute of type Vec2f * If there is no attribute of name iName, it is added. * Otherwise, the new value replaces the old one. - * \param iName + * \param iName: * The name of the attribute - * \param att + * \param att: * The attribute's value */ void setAttributeVec2f(const char *iName, const Vec2f& att); @@ -292,9 +292,9 @@ public: /*! Adds a user defined attribute of type Vec3f * If there is no attribute of name iName, it is added. * Otherwise, the new value replaces the old one. - * \param iName + * \param iName: * The name of the attribute - * \param att + * \param att: * The attribute's value */ void setAttributeVec3f(const char *iName, const Vec3f& att); @@ -562,9 +562,9 @@ public: /*! Builds a stroke from a set of StrokeVertex. * This constructor is templated by an iterator type. * This iterator type must allow the vertices parsing using the ++ operator. - * \param iBegin + * \param iBegin: * The iterator pointing to the first vertex. - * \param iEnd + * \param iEnd: * The iterator pointing to the end of the vertex list. */ template<class InputVertexIterator> @@ -580,7 +580,7 @@ public: /*! Compute the sampling needed to get iNVertices vertices. * If the specified number of vertices is less than the actual number of vertices, the actual sampling value * is returned. (To remove Vertices, use the RemoveVertex() method of this class). - * \param iNVertices + * \param iNVertices: * The number of StrokeVertices we eventually want in our Stroke. * \return the sampling that must be used in the Resample(float) method. * \see Resample(int) @@ -592,7 +592,7 @@ public: * Resamples the curve so that it eventually has iNPoints. That means it is going to add iNPoints-vertices_size, * if vertices_size is the number of points we already have. * If vertices_size >= iNPoints, no resampling is done. - * \param iNPoints + * \param iNPoints: * The number of vertices we eventually want in our stroke. */ int Resample(int iNPoints); @@ -600,7 +600,7 @@ public: /*! Resampling method. * Resamples the curve with a given sampling. * If this sampling is < to the actual sampling value, no resampling is done. - * \param iSampling + * \param iSampling: * The new sampling value. */ int Resample(float iSampling); @@ -618,9 +618,9 @@ public: /*! Inserts the stroke vertex iVertex in the stroke before next. * The length, curvilinear abscissa are updated consequently. - * \param iVertex + * \param iVertex: * The StrokeVertex to insert in the Stroke. - * \param next + * \param next: * A StrokeVertexIterator pointing to the StrokeVeretx before which iVertex must be inserted. */ void InsertVertex(StrokeVertex *iVertex, StrokeInternal::StrokeVertexIterator next); @@ -837,7 +837,7 @@ public: /*! Returns a StrokeVertexIterator pointing on the first StrokeVertex of the Stroke. One can specify a sampling * value to resample the Stroke on the fly if needed. - * \param t + * \param t: * The resampling value with which we want our Stroke to be resampled. * If 0 is specified, no resampling is done. */ diff --git a/source/blender/freestyle/intern/stroke/StrokeShader.h b/source/blender/freestyle/intern/stroke/StrokeShader.h index e655b80d397..1b070a685cc 100644 --- a/source/blender/freestyle/intern/stroke/StrokeShader.h +++ b/source/blender/freestyle/intern/stroke/StrokeShader.h @@ -93,7 +93,7 @@ public: } /*! The shading method. This method must be overloaded by inherited classes. - * \param ioStroke + * \param ioStroke: * The stroke we wish to shade. this Stroke is modified by the Shader (which typically * modifies the Stroke's attribute's values such as Color, Thickness, Geometry...) */ diff --git a/source/blender/freestyle/intern/view_map/FEdgeXDetector.h b/source/blender/freestyle/intern/view_map/FEdgeXDetector.h index cbb47d387fb..99b7c127fff 100644 --- a/source/blender/freestyle/intern/view_map/FEdgeXDetector.h +++ b/source/blender/freestyle/intern/view_map/FEdgeXDetector.h @@ -93,7 +93,7 @@ public: virtual void ProcessCreaseEdge(WXEdge *iEdge); /*! Sets the minimum angle for detecting crease edges - * \param angle + * \param angle: * The angular threshold in degrees (between 0 and 180) for detecting crease edges. An edge is considered * a crease edge if the angle between two faces sharing the edge is smaller than the given threshold. */ @@ -125,7 +125,7 @@ public: virtual void postProcessSuggestiveContourShape(WXShape *iShape); virtual void postProcessSuggestiveContourFace(WXFace *iFace); /*! Sets the minimal derivative of the radial curvature for suggestive contours - * \param dkr + * \param dkr: * The minimal derivative of the radial curvature */ inline void setSuggestiveContourKrDerivativeEpsilon(float dkr) @@ -190,7 +190,7 @@ public: } /*! Sets the radius of the geodesic sphere around each vertex (for the curvature computation) - * \param r + * \param r: * The radius of the sphere expressed as a ratio of the mean edge size */ inline void setSphereRadius(float r) diff --git a/source/blender/freestyle/intern/view_map/Functions0D.h b/source/blender/freestyle/intern/view_map/Functions0D.h index f0009fca6ea..035da76a6e4 100644 --- a/source/blender/freestyle/intern/view_map/Functions0D.h +++ b/source/blender/freestyle/intern/view_map/Functions0D.h @@ -103,7 +103,7 @@ public: } /*! The operator (). - * \param iter + * \param iter: * An Interface0DIterator pointing onto the point at which we wish to evaluate the function. * \return the result of the function of type T. */ diff --git a/source/blender/freestyle/intern/view_map/Functions1D.h b/source/blender/freestyle/intern/view_map/Functions1D.h index f3c8957a804..60b3192910f 100644 --- a/source/blender/freestyle/intern/view_map/Functions1D.h +++ b/source/blender/freestyle/intern/view_map/Functions1D.h @@ -81,7 +81,7 @@ public: } /*! Builds a UnaryFunction1D from an integration type. - * \param iType + * \param iType: * In case the result for the Interface1D would be obtained by evaluating a 0D function over the different * Interface0D of the Interface1D, \a iType tells which integration method to use. * The default integration method is the MEAN. @@ -101,7 +101,7 @@ public: } /*! The operator (). - * \param inter + * \param inter: * The Interface1D on which we wish to evaluate the function. * \return the result of the function of type T. */ @@ -195,7 +195,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ GetXF1D(IntegrationType iType) : UnaryFunction1D<double>(iType) {} @@ -219,7 +219,7 @@ Functions0D::GetYF0D _func; public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ GetYF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {} @@ -243,7 +243,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ GetZF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {} @@ -267,7 +267,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ GetProjectedXF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {} @@ -291,7 +291,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ GetProjectedYF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {} @@ -315,7 +315,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ GetProjectedZF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {} @@ -339,7 +339,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ Orientation2DF1D(IntegrationType iType = MEAN) : UnaryFunction1D<Vec2f>(iType) {} @@ -363,7 +363,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ Orientation3DF1D(IntegrationType iType = MEAN) : UnaryFunction1D<Vec3f>(iType) {} @@ -390,7 +390,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ ZDiscontinuityF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {} @@ -418,7 +418,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ QuantitativeInvisibilityF1D(IntegrationType iType = MEAN) : UnaryFunction1D<unsigned int>(iType) {} @@ -446,7 +446,7 @@ private: public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ CurveNatureF1D(IntegrationType iType = MEAN) : UnaryFunction1D<Nature::EdgeNature>(iType) {} @@ -513,7 +513,7 @@ class Curvature2DAngleF1D : public UnaryFunction1D<double> { public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ Curvature2DAngleF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {} @@ -541,7 +541,7 @@ class Normal2DF1D : public UnaryFunction1D<Vec2f> { public: /*! Builds the functor. - * \param iType + * \param iType: * The integration method used to compute a single value from a set of values. */ Normal2DF1D(IntegrationType iType = MEAN) : UnaryFunction1D<Vec2f>(iType) {} diff --git a/source/blender/freestyle/intern/view_map/Interface1D.h b/source/blender/freestyle/intern/view_map/Interface1D.h index 7afa61ff496..d6f402bf153 100644 --- a/source/blender/freestyle/intern/view_map/Interface1D.h +++ b/source/blender/freestyle/intern/view_map/Interface1D.h @@ -60,14 +60,14 @@ typedef enum { } IntegrationType; /*! Returns a single value from a set of values evaluated at each 0D element of this 1D element. - * \param fun + * \param fun: * The UnaryFunction0D used to compute a value at each Interface0D. - * \param it + * \param it: * The Interface0DIterator used to iterate over the 0D elements of this 1D element. The integration will occur * over the 0D elements starting from the one pointed by it. - * \param it_end + * \param it_end: * The Interface0DIterator pointing the end of the 0D elements of the 1D element. - * \param integration_type + * \param integration_type: * The integration method used to compute a single value from a set of values. * \return the single value obtained for the 1D element. */ @@ -156,7 +156,7 @@ public: /*! Returns an iterator over the Interface1D points, pointing to the first point. The difference with * verticesBegin() is that here we can iterate over points of the 1D element at a any given sampling. * Indeed, for each iteration, a virtual point is created. - * \param t + * \param t: * The sampling with which we want to iterate over points of this 1D element. */ virtual Interface0DIterator pointsBegin(float t = 0.0f); @@ -164,7 +164,7 @@ public: /*! Returns an iterator over the Interface1D points, pointing after the last point. The difference with * verticesEnd() is that here we can iterate over points of the 1D element at a any given sampling. * Indeed, for each iteration, a virtual point is created. - * \param t + * \param t: * The sampling with which we want to iterate over points of this 1D element. */ virtual Interface0DIterator pointsEnd(float t = 0.0f); diff --git a/source/blender/freestyle/intern/view_map/Silhouette.h b/source/blender/freestyle/intern/view_map/Silhouette.h index 44bce375a75..a18cf41797b 100644 --- a/source/blender/freestyle/intern/view_map/Silhouette.h +++ b/source/blender/freestyle/intern/view_map/Silhouette.h @@ -949,7 +949,7 @@ public: /*! Returns an iterator over the FEdge points, pointing to the first point. The difference with verticesBegin() * is that here we can iterate over points of the FEdge at a any given sampling. * Indeed, for each iteration, a virtual point is created. - * \param t + * \param t: * The sampling with which we want to iterate over points of this FEdge. */ virtual inline Interface0DIterator pointsBegin(float t = 0.0f); @@ -957,7 +957,7 @@ public: /*! Returns an iterator over the FEdge points, pointing after the last point. The difference with verticesEnd() * is that here we can iterate over points of the FEdge at a any given sampling. * Indeed, for each iteration, a virtual point is created. - * \param t + * \param t: * The sampling with which we want to iterate over points of this FEdge. */ virtual inline Interface0DIterator pointsEnd(float t = 0.0f); diff --git a/source/blender/freestyle/intern/view_map/SteerableViewMap.h b/source/blender/freestyle/intern/view_map/SteerableViewMap.h index 0327b4a460e..1259d081209 100644 --- a/source/blender/freestyle/intern/view_map/SteerableViewMap.h +++ b/source/blender/freestyle/intern/view_map/SteerableViewMap.h @@ -82,27 +82,27 @@ public: double ComputeWeight(const Vec2d& dir, unsigned iNOrientation); /*! Returns the number of the SVM to which a direction belongs to. - * \param dir + * \param dir: * The direction */ unsigned getSVMNumber(const Vec2f& dir); /*! Returns the number of the SVM to which a FEdge belongs most. - * \param id + * \param id: * The First element of the Id struct of the FEdge we're interested in. */ unsigned getSVMNumber(unsigned id); /*! Builds _nbOrientations+1 pyramids of images from the _nbOrientations+1 base images of the steerable viewmap. - * \param steerableBases + * \param steerableBases: * The _nbOrientations+1 images constituting the basis for the steerable pyramid. - * \param copy + * \param copy: * If false, the data is not duplicated, and Canvas deals with the memory management of these * _nbOrientations+1 images. If true, data is copied, and it's up to the caller to delete the images. - * \param iNbLevels + * \param iNbLevels: * The number of levels desired for each pyramid. * If iNbLevels == 0, the complete pyramid is built. - * \param iSigma + * \param iSigma: * The sigma that will be used for the gaussian blur */ void buildImagesPyramids(GrayImage **steerableBases, bool copy = false, unsigned iNbLevels = 4, @@ -110,7 +110,7 @@ public: /*! Reads a pixel value in one of the VewMap density steerable pyramids. * Returns a value between 0 and 1. - * \param iOrientation + * \param iOrientation: * the number telling which orientation we need to check. * There are _nbOrientations+1 oriented ViewMaps: * 0 -> the ViewMap containing every horizontal lines @@ -118,11 +118,11 @@ public: * 2 -> the ViewMap containing every vertical lines * 3 -> the ViewMap containing every lines whose orientation is around 3PI/4 * 4 -> the complete ViewMap - * \param iLevel + * \param iLevel: * The level of the pyramid we want to read - * \param x + * \param x: * The abscissa of the desired pixel specified in level0 coordinate system. The origin is the lower left corner. - * \param y + * \param y: * The ordinate of the desired pixel specified in level0 coordinate system. The origin is the lower left corner. */ float readSteerableViewMapPixel(unsigned iOrientation, int iLevel, int x, int y); diff --git a/source/blender/freestyle/intern/view_map/ViewMap.h b/source/blender/freestyle/intern/view_map/ViewMap.h index 74fb875ffc6..0acc6ca39d8 100644 --- a/source/blender/freestyle/intern/view_map/ViewMap.h +++ b/source/blender/freestyle/intern/view_map/ViewMap.h @@ -1364,14 +1364,14 @@ public: /*! Returns an Interface0DIterator to iterate over the points of this ViewEdge at a given resolution. * The returned Interface0DIterator points on the first Point of the ViewEdge. - * \param t + * \param t: * the sampling value. */ virtual Interface0DIterator pointsBegin(float t = 0.0f); /*! Returns an Interface0DIterator to iterate over the points of this ViewEdge at a given resolution. * The returned Interface0DIterator points after the last Point of the ViewEdge. - * \param t + * \param t: * the sampling value. */ virtual Interface0DIterator pointsEnd(float t = 0.0f); diff --git a/source/blender/freestyle/intern/view_map/ViewMapIterators.h b/source/blender/freestyle/intern/view_map/ViewMapIterators.h index b10de13cef7..bec57bf36df 100644 --- a/source/blender/freestyle/intern/view_map/ViewMapIterators.h +++ b/source/blender/freestyle/intern/view_map/ViewMapIterators.h @@ -417,9 +417,9 @@ class ViewEdgeIterator : public Iterator { public: /*! Builds a ViewEdgeIterator from a starting ViewEdge and its orientation. - * \param begin + * \param begin: * The ViewEdge from where to start the iteration. - * \param orientation + * \param orientation: * If true, we'll look for the next ViewEdge among the ViewEdges that surround the ending ViewVertex of begin. * If false, we'll search over the ViewEdges surrounding the ending ViewVertex of begin. */ diff --git a/source/blender/imbuf/IMB_metadata.h b/source/blender/imbuf/IMB_metadata.h index 6a29fa01594..0321d5ef0fb 100644 --- a/source/blender/imbuf/IMB_metadata.h +++ b/source/blender/imbuf/IMB_metadata.h @@ -54,11 +54,11 @@ void IMB_metadata_ensure(struct IDProperty **metadata); void IMB_metadata_free(struct IDProperty *metadata); /** Read the field from the image info into the field. - * \param metadata - the IDProperty that contains the metadata - * \param key - the key of the field - * \param value - the data in the field, first one found with key is returned, + * \param metadata: the IDProperty that contains the metadata + * \param key: the key of the field + * \param value: the data in the field, first one found with key is returned, * memory has to be allocated by user. - * \param len - length of value buffer allocated by user. + * \param len: length of value buffer allocated by user. * \return - 1 (true) if metadata is present and value for the key found, 0 (false) otherwise */ bool IMB_metadata_get_field(struct IDProperty *metadata, const char *key, char *value, const size_t len); @@ -66,9 +66,9 @@ bool IMB_metadata_get_field(struct IDProperty *metadata, const char *key, char * /** Set user data in the metadata. * If the field already exists its value is overwritten, otherwise the field * will be added with the given value. - * \param metadata - the IDProperty that contains the metadata - * \param key - the key of the field - * \param value - the data to be written to the field. zero terminated string + * \param metadata: the IDProperty that contains the metadata + * \param key: the key of the field + * \param value: the data to be written to the field. zero terminated string */ void IMB_metadata_set_field(struct IDProperty *metadata, const char *key, const char *value); diff --git a/source/blender/imbuf/intern/openexr/openexr_api.cpp b/source/blender/imbuf/intern/openexr/openexr_api.cpp index bad5e0efd65..99b3bdb9015 100644 --- a/source/blender/imbuf/intern/openexr/openexr_api.cpp +++ b/source/blender/imbuf/intern/openexr/openexr_api.cpp @@ -302,7 +302,7 @@ extern "C" /** * Test presence of OpenEXR file. - * \param mem pointer to loaded OpenEXR bitstream + * \param mem: pointer to loaded OpenEXR bitstream */ int imb_is_a_openexr(const unsigned char *mem) { diff --git a/source/blender/makesdna/intern/dna_genfile.c b/source/blender/makesdna/intern/dna_genfile.c index 077bae741b8..cae702da3c3 100644 --- a/source/blender/makesdna/intern/dna_genfile.c +++ b/source/blender/makesdna/intern/dna_genfile.c @@ -193,8 +193,8 @@ static bool ispointer(const char *name) /** * Returns the size of struct fields of the specified type and name. * - * \param type Index into sdna->types/typelens - * \param name Index into sdna->names, + * \param type: Index into sdna->types/typelens + * \param name: Index into sdna->names, * needed to extract possible pointer/array information. */ static int elementsize(const SDNA *sdna, short type, short name) @@ -753,11 +753,11 @@ static eSDNA_Type sdna_type_nr(const char *dna_type) * Note there is no optimization for the case where otype and ctype are the same: * assumption is that caller will handle this case. * - * \param ctype Name of type to convert to - * \param otype Name of type to convert from - * \param name Field name to extract array-size information - * \param curdata Where to put converted data - * \param olddata Data of type otype to convert + * \param ctype: Name of type to convert to + * \param otype: Name of type to convert from + * \param name: Field name to extract array-size information + * \param curdata: Where to put converted data + * \param olddata: Data of type otype to convert */ static void cast_elem( const char *ctype, const char *otype, const char *name, @@ -836,11 +836,11 @@ static void cast_elem( * as lookup keys to identify data blocks in the saved .blend file, not * as actual in-memory pointers. * - * \param curlen Pointer length to conver to - * \param oldlen Length of pointers in olddata - * \param name Field name to extract array-size information - * \param curdata Where to put converted data - * \param olddata Data to convert + * \param curlen: Pointer length to conver to + * \param oldlen: Length of pointers in olddata + * \param name: Field name to extract array-size information + * \param curdata: Where to put converted data + * \param olddata: Data to convert */ static void cast_pointer(int curlen, int oldlen, const char *name, char *curdata, const char *olddata) { @@ -897,10 +897,10 @@ static int elem_strcmp(const char *name, const char *oname) * Returns whether the specified field exists according to the struct format * pointed to by old. * - * \param sdna Old SDNA - * \param type Current field type name - * \param name Current field name - * \param old Pointer to struct information in sdna + * \param sdna: Old SDNA + * \param type: Current field type name + * \param name: Current field name + * \param old: Pointer to struct information in sdna * \return true when existing, false otherwise. */ static bool elem_exists( @@ -935,12 +935,12 @@ static bool elem_exists( * return NULL both when the field is found at offset 0 and when it is not * found at all. For field existence checks, use elem_exists() instead. * - * \param sdna Old SDNA - * \param type Current field type name - * \param name Current field name - * \param old Pointer to struct information in sdna - * \param olddata Struct data - * \param sppo Optional place to return pointer to field info in sdna + * \param sdna: Old SDNA + * \param type: Current field type name + * \param name: Current field name + * \param old: Pointer to struct information in sdna + * \param olddata: Struct data + * \param sppo: Optional place to return pointer to field info in sdna * \return Data address. */ static const char *find_elem( @@ -984,13 +984,13 @@ static const char *find_elem( * Converts the contents of a single field of a struct, of a non-struct type, * from oldsdna to newsdna format. * - * \param newsdna SDNA of current Blender - * \param oldsdna SDNA of Blender that saved file - * \param type current field type name - * \param name current field name - * \param curdata put field data converted to newsdna here - * \param old pointer to struct info in oldsdna - * \param olddata struct contents laid out according to oldsdna + * \param newsdna: SDNA of current Blender + * \param oldsdna: SDNA of Blender that saved file + * \param type: current field type name + * \param name: current field name + * \param curdata: put field data converted to newsdna here + * \param old: pointer to struct info in oldsdna + * \param olddata: struct contents laid out according to oldsdna */ static void reconstruct_elem( const SDNA *newsdna, @@ -1080,15 +1080,15 @@ static void reconstruct_elem( /** * Converts the contents of an entire struct from oldsdna to newsdna format. * - * \param newsdna SDNA of current Blender - * \param oldsdna SDNA of Blender that saved file - * \param compflags + * \param newsdna: SDNA of current Blender + * \param oldsdna: SDNA of Blender that saved file + * \param compflags: * * Result from DNA_struct_get_compareflags to avoid needless conversions. - * \param oldSDNAnr Index of old struct definition in oldsdna - * \param data Struct contents laid out according to oldsdna - * \param curSDNAnr Index of current struct definition in newsdna - * \param cur Where to put converted struct contents + * \param oldSDNAnr: Index of old struct definition in oldsdna + * \param data: Struct contents laid out according to oldsdna + * \param curSDNAnr: Index of current struct definition in newsdna + * \param cur: Where to put converted struct contents */ static void reconstruct_struct( const SDNA *newsdna, @@ -1187,9 +1187,9 @@ static void reconstruct_struct( /** * Does endian swapping on the fields of a struct value. * - * \param oldsdna SDNA of Blender that saved file - * \param oldSDNAnr Index of struct info within oldsdna - * \param data Struct data + * \param oldsdna: SDNA of Blender that saved file + * \param oldSDNAnr: Index of struct info within oldsdna + * \param data: Struct data */ void DNA_struct_switch_endian(const SDNA *oldsdna, int oldSDNAnr, char *data) { @@ -1273,14 +1273,14 @@ void DNA_struct_switch_endian(const SDNA *oldsdna, int oldSDNAnr, char *data) } /** - * \param newsdna SDNA of current Blender - * \param oldsdna SDNA of Blender that saved file - * \param compflags + * \param newsdna: SDNA of current Blender + * \param oldsdna: SDNA of Blender that saved file + * \param compflags: * * Result from DNA_struct_get_compareflags to avoid needless conversions - * \param oldSDNAnr Index of struct info within oldsdna - * \param blocks The number of array elements - * \param data Array of struct data + * \param oldSDNAnr: Index of struct info within oldsdna + * \param blocks: The number of array elements + * \param data: Array of struct data * \return An allocated reconstructed struct */ void *DNA_struct_reconstruct( diff --git a/source/blender/makesdna/intern/makesdna.c b/source/blender/makesdna/intern/makesdna.c index 5d5efda975f..a6262a9b130 100644 --- a/source/blender/makesdna/intern/makesdna.c +++ b/source/blender/makesdna/intern/makesdna.c @@ -166,14 +166,14 @@ static int additional_slen_offset; /** * Add type \c str to struct indexed by \c len, if it was not yet found. - * \param str char - * \param len int + * \param str: char + * \param len: int */ static int add_type(const char *str, int len); /** * Add variable \c str to - * \param str + * \param str: */ static int add_name(const char *str); diff --git a/source/blender/makesrna/intern/rna_define.c b/source/blender/makesrna/intern/rna_define.c index d004491a33b..d67113bcddf 100644 --- a/source/blender/makesrna/intern/rna_define.c +++ b/source/blender/makesrna/intern/rna_define.c @@ -1423,7 +1423,7 @@ void RNA_def_property_ui_icon(PropertyRNA *prop, int icon, bool consecutive) * For floats this is (step * UI_PRECISION_FLOAT_SCALE), why? - nobody knows. * For ints, whole values are used. * - * \param precision The number of zeros to show + * \param precision: The number of zeros to show * (as a whole number - common range is 1 - 6), see UI_PRECISION_FLOAT_MAX */ void RNA_def_property_ui_range(PropertyRNA *prop, double min, double max, double step, int precision) diff --git a/source/blender/modifiers/intern/MOD_solidify.c b/source/blender/modifiers/intern/MOD_solidify.c index 8cf288e19ae..474c36aa117 100644 --- a/source/blender/modifiers/intern/MOD_solidify.c +++ b/source/blender/modifiers/intern/MOD_solidify.c @@ -69,9 +69,9 @@ BLI_INLINE bool edgeref_is_init(const EdgeFaceRef *edge_ref) } /** - * \param dm Mesh to calculate normals for. - * \param face_nors Precalculated face normals. - * \param r_vert_nors Return vert normals. + * \param dm: Mesh to calculate normals for. + * \param face_nors: Precalculated face normals. + * \param r_vert_nors: Return vert normals. */ static void dm_calc_normal(DerivedMesh *dm, float (*face_nors)[3], float (*r_vert_nors)[3]) { diff --git a/source/blender/physics/intern/ConstrainedConjugateGradient.h b/source/blender/physics/intern/ConstrainedConjugateGradient.h index 8d8dc1ae187..bf4fa2870c0 100644 --- a/source/blender/physics/intern/ConstrainedConjugateGradient.h +++ b/source/blender/physics/intern/ConstrainedConjugateGradient.h @@ -9,13 +9,13 @@ namespace Eigen { namespace internal { /** \internal Low-level conjugate gradient algorithm - * \param mat The matrix A - * \param rhs The right hand side vector b - * \param x On input and initial solution, on output the computed solution. - * \param precond A preconditioner being able to efficiently solve for an + * \param mat: The matrix A + * \param rhs: The right hand side vector b + * \param x: On input and initial solution, on output the computed solution. + * \param precond: A preconditioner being able to efficiently solve for an * approximation of Ax=b (regardless of b) - * \param iters On input the max number of iteration, on output the number of performed iterations. - * \param tol_error On input the tolerance error, on output an estimation of the relative error. + * \param iters: On input the max number of iteration, on output the number of performed iterations. + * \param tol_error: On input the tolerance error, on output an estimation of the relative error. */ template<typename MatrixType, typename Rhs, typename Dest, typename FilterMatrixType, typename Preconditioner> EIGEN_DONT_INLINE diff --git a/source/blender/python/bmesh/bmesh_py_ops_call.c b/source/blender/python/bmesh/bmesh_py_ops_call.c index 013a22fd563..14e14cd5fe3 100644 --- a/source/blender/python/bmesh/bmesh_py_ops_call.c +++ b/source/blender/python/bmesh/bmesh_py_ops_call.c @@ -65,10 +65,10 @@ static int bpy_bm_op_as_py_error(BMesh *bm) /** * \brief Utility function to check BMVert/BMEdge/BMFace's * - * \param value - * \param bm Check the \a value against this. - * \param htype Test \a value matches this type. - * \param descr Description text. + * \param value: + * \param bm: Check the \a value against this. + * \param htype: Test \a value matches this type. + * \param descr: Description text. */ static int bpy_slot_from_py_elem_check( BPy_BMElem *value, BMesh *bm, const char htype, @@ -103,11 +103,11 @@ static int bpy_slot_from_py_elem_check( /** * \brief Utility function to check BMVertSeq/BMEdgeSeq/BMFaceSeq's * - * \param value Caller must check its a BMeshSeq - * \param bm Check the \a value against this. - * \param htype_py The type(s) of \a value. - * \param htype_bmo The type(s) supported by the target slot. - * \param descr Description text. + * \param value: Caller must check its a BMeshSeq + * \param bm: Check the \a value against this. + * \param htype_py: The type(s) of \a value. + * \param htype_bmo: The type(s) supported by the target slot. + * \param descr: Description text. */ static int bpy_slot_from_py_elemseq_check( BPy_BMGeneric *value, BMesh *bm, diff --git a/source/blender/python/mathutils/mathutils_Matrix.c b/source/blender/python/mathutils/mathutils_Matrix.c index 951c094ec40..c72d3c31b1f 100644 --- a/source/blender/python/mathutils/mathutils_Matrix.c +++ b/source/blender/python/mathutils/mathutils_Matrix.c @@ -969,7 +969,7 @@ static void matrix_invert_with_det_n_internal(float *mat_dst, const float *mat_s } /** - * \param r_mat can be from ``self->matrix`` or not. + * \param r_mat: can be from ``self->matrix`` or not. */ static bool matrix_invert_internal(const MatrixObject *self, float *r_mat) { @@ -988,7 +988,7 @@ static bool matrix_invert_internal(const MatrixObject *self, float *r_mat) /** * Similar to ``matrix_invert_internal`` but should never error. - * \param r_mat can be from ``self->matrix`` or not. + * \param r_mat: can be from ``self->matrix`` or not. */ static void matrix_invert_safe_internal(const MatrixObject *self, float *r_mat) { diff --git a/source/blender/render/intern/include/shadbuf.h b/source/blender/render/intern/include/shadbuf.h index 5901d2187dc..5722f37a6a8 100644 --- a/source/blender/render/intern/include/shadbuf.h +++ b/source/blender/render/intern/include/shadbuf.h @@ -37,7 +37,7 @@ /** * Calculates shadowbuffers for a vector of shadow-giving lamps - * \param lar The vector of lamps + * \param lar: The vector of lamps */ void makeshadowbuf(struct Render *re, LampRen *lar); void freeshadowbuf(struct LampRen *lar); @@ -49,8 +49,8 @@ void threaded_makeshadowbufs(struct Render *re); * communication with global variables here. * \return The shadow factors: 1.0 for no shadow, 0.0 for complete * shadow. - * \param shb The shadowbuffer to find the shadow factor in. - * \param inp The inproduct between viewvector and ? + * \param shb: The shadowbuffer to find the shadow factor in. + * \param inp: The inproduct between viewvector and ? * */ float testshadowbuf(struct Render *re, struct ShadBuf *shb, const float rco[3], const float dxco[3], const float dyco[3], float inp, float mat_bias); diff --git a/source/blender/render/intern/source/pixelshading.c b/source/blender/render/intern/source/pixelshading.c index 7f202629ce4..41d679c0b58 100644 --- a/source/blender/render/intern/source/pixelshading.c +++ b/source/blender/render/intern/source/pixelshading.c @@ -243,7 +243,7 @@ static void render_lighting_halo(HaloRen *har, float col_r[3]) /** * Converts a halo z-buffer value to distance from the camera's near plane - * \param z The z-buffer value to convert + * \param z: The z-buffer value to convert * \return a distance from the camera's near plane in blender units */ static float haloZtoDist(int z) @@ -262,13 +262,13 @@ static float haloZtoDist(int z) } /** - * \param col (float[4]) Store the rgb color here (with alpha) + * \param col: (float[4]) Store the rgb color here (with alpha) * The alpha is used to blend the color to the background * color_new = (1-alpha)*color_background + color - * \param zz The current zbuffer value at the place of this pixel - * \param dist Distance of the pixel from the center of the halo squared. Given in pixels - * \param xn The x coordinate of the pixel relaticve to the center of the halo. given in pixels - * \param yn The y coordinate of the pixel relaticve to the center of the halo. given in pixels + * \param zz: The current zbuffer value at the place of this pixel + * \param dist: Distance of the pixel from the center of the halo squared. Given in pixels + * \param xn: The x coordinate of the pixel relaticve to the center of the halo. given in pixels + * \param yn: The y coordinate of the pixel relaticve to the center of the halo. given in pixels */ int shadeHaloFloat(HaloRen *har, float col[4], int zz, float dist, float xn, float yn, short flarec) diff --git a/source/blender/render/intern/source/zbuf.c b/source/blender/render/intern/source/zbuf.c index 6c11dee5dde..8c81187df5f 100644 --- a/source/blender/render/intern/source/zbuf.c +++ b/source/blender/render/intern/source/zbuf.c @@ -1037,9 +1037,9 @@ void zbufsinglewire(ZSpan *zspan, int obi, int zvlnr, const float ho1[4], const * This is one of the z buffer fill functions called in zbufclip() and * zbufwireclip(). * - * \param v1 [4 floats, world coordinates] first vertex - * \param v2 [4 floats, world coordinates] second vertex - * \param v3 [4 floats, world coordinates] third vertex + * \param v1: [4 floats, world coordinates] first vertex + * \param v2: [4 floats, world coordinates] second vertex + * \param v3: [4 floats, world coordinates] third vertex */ /* WATCH IT: zbuffillGLinv4 and zbuffillGL4 are identical except for a 2 lines, @@ -1292,9 +1292,9 @@ static void zbuffillGL4(ZSpan *zspan, int obi, int zvlnr, * This is one of the z buffer fill functions called in zbufclip() and * zbufwireclip(). * - * \param v1 [4 floats, world coordinates] first vertex - * \param v2 [4 floats, world coordinates] second vertex - * \param v3 [4 floats, world coordinates] third vertex + * \param v1: [4 floats, world coordinates] first vertex + * \param v2: [4 floats, world coordinates] second vertex + * \param v3: [4 floats, world coordinates] third vertex */ /* now: filling two Z values, the closest and 2nd closest */ @@ -1592,11 +1592,11 @@ void zspan_scanconvert(ZSpan *zspan, void *handle, float *v1, float *v2, float * * Sets lambda: flag, and parametrize the clipping of vertices in * viewspace coordinates. lambda = -1 means no clipping, lambda in [0, 1] means a clipping. * Note: uses globals. - * \param v1 start coordinate s - * \param v2 target coordinate t - * \param b2 - * \param b3 - * \param a index for coordinate (x, y, or z) + * \param v1: start coordinate s + * \param v2: target coordinate t + * \param b2: + * \param b3: + * \param a: index for coordinate (x, y, or z) */ static void clippyra(float *lambda, float *v1, float *v2, int *b2, int *b3, int a, float clipcrop) @@ -1652,11 +1652,11 @@ static void clippyra(float *lambda, float *v1, float *v2, int *b2, int *b3, int * vertex list of this face. * * - * \param v1 start coordinate s - * \param v2 target coordinate t - * \param b1 - * \param b2 - * \param clve vertex vector. + * \param v1: start coordinate s + * \param v2: target coordinate t + * \param b1: + * \param b2: + * \param clve: vertex vector. */ static void makevertpyra(float *vez, float *lambda, float **trias, float *v1, float *v2, int *b1, int *clve) diff --git a/source/blender/windowmanager/intern/wm.c b/source/blender/windowmanager/intern/wm.c index 132789aade4..2efd3a13920 100644 --- a/source/blender/windowmanager/intern/wm.c +++ b/source/blender/windowmanager/intern/wm.c @@ -123,8 +123,8 @@ void WM_operator_free_all_after(wmWindowManager *wm, struct wmOperator *op) * Use with extreme care!, * properties, customdata etc - must be compatible. * - * \param op Operator to assign the type to. - * \param ot OperatorType to assign. + * \param op: Operator to assign the type to. + * \param ot: OperatorType to assign. */ void WM_operator_type_set(wmOperator *op, wmOperatorType *ot) { diff --git a/source/blender/windowmanager/intern/wm_cursors.c b/source/blender/windowmanager/intern/wm_cursors.c index e789099c799..c488eca0583 100644 --- a/source/blender/windowmanager/intern/wm_cursors.c +++ b/source/blender/windowmanager/intern/wm_cursors.c @@ -191,7 +191,7 @@ void WM_cursor_wait(bool val) } /** - * \param bounds can be NULL + * \param bounds: can be NULL */ void WM_cursor_grab_enable(wmWindow *win, bool wrap, bool hide, int bounds[4]) { diff --git a/source/blender/windowmanager/intern/wm_event_system.c b/source/blender/windowmanager/intern/wm_event_system.c index 0084c3a5407..380fa81ebf6 100644 --- a/source/blender/windowmanager/intern/wm_event_system.c +++ b/source/blender/windowmanager/intern/wm_event_system.c @@ -847,7 +847,7 @@ static int wm_operator_exec_notest(bContext *C, wmOperator *op) /** * for running operators with frozen context (modal handlers, menus) * - * \param store Store settings for re-use. + * \param store: Store settings for re-use. * * warning: do not use this within an operator to call its self! [#29537] */ int WM_operator_call_ex(bContext *C, wmOperator *op, diff --git a/source/blender/windowmanager/intern/wm_operators.c b/source/blender/windowmanager/intern/wm_operators.c index 2008d388ad3..ddb9db37054 100644 --- a/source/blender/windowmanager/intern/wm_operators.c +++ b/source/blender/windowmanager/intern/wm_operators.c @@ -605,7 +605,7 @@ void WM_operator_properties_sanitize(PointerRNA *ptr, const bool no_context) /** set all props to their default, - * \param do_update Only update un-initialized props. + * \param do_update: Only update un-initialized props. * * \note, there's nothing specific to operators here. * this could be made a general function. diff --git a/source/blender/windowmanager/intern/wm_window.c b/source/blender/windowmanager/intern/wm_window.c index 04a236e5d66..2b70ee99882 100644 --- a/source/blender/windowmanager/intern/wm_window.c +++ b/source/blender/windowmanager/intern/wm_window.c @@ -425,7 +425,7 @@ static void wm_confirm_quit(bContext *C) * still cancel via the confirmation popup. Also, this may not quit Blender * immediately, but rather schedule the closing. * - * \param win The window to show the confirmation popup/window in. + * \param win: The window to show the confirmation popup/window in. */ void wm_quit_with_optional_confirmation_prompt(bContext *C, wmWindow *win) { |