diff options
89 files changed, 549 insertions, 299 deletions
diff --git a/intern/ghost/intern/GHOST_ContextCGL.mm b/intern/ghost/intern/GHOST_ContextCGL.mm index 12c340ffe97..1fbce0c1e6b 100644 --- a/intern/ghost/intern/GHOST_ContextCGL.mm +++ b/intern/ghost/intern/GHOST_ContextCGL.mm @@ -17,7 +17,7 @@ * All rights reserved. */ -/** \file ghost/intern/GHOST_ContextCGL.mm +/** \file * \ingroup GHOST * * Definition of GHOST_ContextCGL class. diff --git a/intern/memutil/MEM_RefCountedC-Api.h b/intern/memutil/MEM_RefCountedC-Api.h index 25dcf11b7aa..2a132f3c173 100644 --- a/intern/memutil/MEM_RefCountedC-Api.h +++ b/intern/memutil/MEM_RefCountedC-Api.h @@ -37,23 +37,23 @@ extern "C" { /** * Returns the reference count of this object. - * @param shared The object to query. - * @return The current reference count. + * \param shared: The object to query. + * \return The current reference count. */ extern int MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared); /** * Increases the reference count of this object. - * @param shared The object to query. - * @return The new reference count. + * \param shared: The object to query. + * \return The new reference count. */ extern int MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared); /** * Decreases the reference count of this object. * If the reference count reaches zero, the object self-destructs. - * @param shared The object to query. - * @return The new reference count. + * \param shared: The object to query. + * \return The new reference count. */ extern int MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared); diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h index 2145a673e45..e167cfd6fcb 100644 --- a/source/blender/blenkernel/BKE_DerivedMesh.h +++ b/source/blender/blenkernel/BKE_DerivedMesh.h @@ -296,8 +296,9 @@ void DM_from_template(DerivedMesh *dm, int numLoops, int numPolys); -/** utility function to release a DerivedMesh's layers - * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise +/** + * Utility function to release a DerivedMesh's layers + * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise. */ int DM_release(DerivedMesh *dm); diff --git a/source/blender/blenkernel/BKE_customdata.h b/source/blender/blenkernel/BKE_customdata.h index f354e5e6de3..f5665707a0c 100644 --- a/source/blender/blenkernel/BKE_customdata.h +++ b/source/blender/blenkernel/BKE_customdata.h @@ -168,8 +168,8 @@ bool CustomData_bmesh_merge(const struct CustomData *source, /** NULL's all members and resets the typemap. */ void CustomData_reset(struct CustomData *data); -/** frees data associated with a CustomData object (doesn't free the object - * itself, though) +/** + * Frees data associated with a CustomData object (doesn't free the object itself, though). */ void CustomData_free(struct CustomData *data, int totelem); diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h index a5b9b1e5148..9501d3f8ec9 100644 --- a/source/blender/blenkernel/BKE_node.h +++ b/source/blender/blenkernel/BKE_node.h @@ -74,7 +74,9 @@ struct uiLayout; /** \name Node Type Definitions * \{ */ -/** Compact definition of a node socket. +/** + * \brief Compact definition of a node socket. + * * Can be used to quickly define a list of static sockets for a node, * which are added to each new node of that type. * @@ -95,7 +97,9 @@ typedef struct bNodeSocketTemplate { char identifier[64]; /* generated from name */ } bNodeSocketTemplate; -/** Defines a socket type. +/** + * \brief Defines a socket type. + * * Defines the appearance and behavior of a socket in the UI. */ typedef struct bNodeSocketType { @@ -155,7 +159,9 @@ typedef int (*NodeGPUExecFunction)(struct GPUMaterial *mat, struct GPUNodeStack *in, struct GPUNodeStack *out); -/** Defines a node type. +/** + * \brief Defines a node type. + * * Initial attributes and constants for a node as well as callback functions * implementing the node behavior. */ diff --git a/source/blender/blenkernel/intern/action.c b/source/blender/blenkernel/intern/action.c index de1cbd236fb..ad6c696b655 100644 --- a/source/blender/blenkernel/intern/action.c +++ b/source/blender/blenkernel/intern/action.c @@ -502,9 +502,10 @@ bool BKE_pose_channels_is_valid(const bPose *pose) #endif /** - * Find the active posechannel for an object (we can't just use pose, as layer info is in armature) + * Find the active pose-channel for an object + * (we can't just use pose, as layer info is in armature) * - * \note: Object, not bPose is used here, as we need layer info from Armature) + * \note #Object, not #bPose is used here, as we need layer info from Armature. */ bPoseChannel *BKE_pose_channel_active(Object *ob) { diff --git a/source/blender/blenkernel/intern/anim_sys.c b/source/blender/blenkernel/intern/anim_sys.c index 2e655452a21..88a8463b994 100644 --- a/source/blender/blenkernel/intern/anim_sys.c +++ b/source/blender/blenkernel/intern/anim_sys.c @@ -180,8 +180,10 @@ AnimData *BKE_animdata_add_id(ID *id) /* Action Setter --------------------------------------- */ -/** Called when user tries to change the active action of an AnimData block - * (via RNA, Outliner, etc.) */ +/** + * Called when user tries to change the active action of an AnimData block + * (via RNA, Outliner, etc.) + */ bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act) { AnimData *adt = BKE_animdata_from_id(id); diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c index 4d9a92d3ead..58b0c9b41ea 100644 --- a/source/blender/blenkernel/intern/armature.c +++ b/source/blender/blenkernel/intern/armature.c @@ -1239,8 +1239,10 @@ void BKE_pchan_bbone_segments_cache_copy(bPoseChannel *pchan, bPoseChannel *pcha } } -/** Calculate index and blend factor for the two B-Bone segment nodes - * affecting the point at 0 <= pos <= 1. */ +/** + * Calculate index and blend factor for the two B-Bone segment nodes + * affecting the point at 0 <= pos <= 1. + */ void BKE_pchan_bbone_deform_segment_index(const bPoseChannel *pchan, float pos, int *r_index, diff --git a/source/blender/blenkernel/intern/colortools.c b/source/blender/blenkernel/intern/colortools.c index b129bf14bb8..8166bbea962 100644 --- a/source/blender/blenkernel/intern/colortools.c +++ b/source/blender/blenkernel/intern/colortools.c @@ -1051,7 +1051,8 @@ static void curvemapping_evaluateRGBF_filmlike(const CurveMapping *cumap, vecout[channel_offset[2]] = v2; } -/** same as #BKE_curvemapping_evaluate_premulRGBF +/** + * Same as #BKE_curvemapping_evaluate_premulRGBF * but black/bwmul are passed as args for the compositor * where they can change per pixel. * diff --git a/source/blender/blenkernel/intern/crazyspace.c b/source/blender/blenkernel/intern/crazyspace.c index f2ed84b4125..9618ef8c78e 100644 --- a/source/blender/blenkernel/intern/crazyspace.c +++ b/source/blender/blenkernel/intern/crazyspace.c @@ -251,8 +251,10 @@ void BKE_crazyspace_set_quats_mesh(Mesh *me, } } -/** returns an array of deform matrices for crazyspace correction, and the - * number of modifiers left */ +/** + * Returns an array of deform matrices for crazyspace correction, + * and the number of modifiers left. + */ int BKE_crazyspace_get_first_deform_matrices_editbmesh(struct Depsgraph *depsgraph, Scene *scene, Object *ob, diff --git a/source/blender/blenkernel/intern/curveprofile.c b/source/blender/blenkernel/intern/curveprofile.c index f07d29c0807..2b253d439e0 100644 --- a/source/blender/blenkernel/intern/curveprofile.c +++ b/source/blender/blenkernel/intern/curveprofile.c @@ -75,8 +75,10 @@ CurveProfile *BKE_curveprofile_copy(const CurveProfile *profile) return NULL; } -/** Removes a specific point from the path of control points. - * \note: Requires curveprofile_update call after. */ +/** + * Removes a specific point from the path of control points. + * \note Requires #BKE_curveprofile_update call after. + */ bool BKE_curveprofile_remove_point(CurveProfile *profile, CurveProfilePoint *point) { CurveProfilePoint *pts; @@ -105,9 +107,13 @@ bool BKE_curveprofile_remove_point(CurveProfile *profile, CurveProfilePoint *poi return true; } -/** Removes every point in the widget with the supplied flag set, except for the first and last. - * \param flag: CurveProfilePoint->flag. - * \note: Requires curveprofile_update call after. */ +/** + * Removes every point in the widget with the supplied flag set, except for the first and last. + * + * \param flag: #CurveProfilePoint.flag. + * + * \note Requires #BKE_curveprofile_update call after. + */ void BKE_curveprofile_remove_by_flag(CurveProfile *profile, const short flag) { int i_old, i_new, n_removed = 0; @@ -134,10 +140,13 @@ void BKE_curveprofile_remove_by_flag(CurveProfile *profile, const short flag) profile->path_len -= n_removed; } -/** Adds a new point at the specified location. The choice for which points to place the new vertex +/** + * Adds a new point at the specified location. The choice for which points to place the new vertex * between is made by checking which control point line segment is closest to the new point and * placing the new vertex in between that segment's points. - * \note: Requires curveprofile_update call after. */ + * + * \note Requires #BKE_curveprofile_update call after. + */ CurveProfilePoint *BKE_curveprofile_insert(CurveProfile *profile, float x, float y) { CurveProfilePoint *new_pt = NULL; @@ -202,7 +211,8 @@ CurveProfilePoint *BKE_curveprofile_insert(CurveProfile *profile, float x, float /** * Sets the handle type of the selected control points. * \param type_1, type_2: Either HD_VECT or HD_AUTO. Handle types for the first and second handles. - * \note: Requires curveprofile_update call after. + * + * \note Requires #BKE_curveprofile_update call after. */ void BKE_curveprofile_selected_handle_set(CurveProfile *profile, int type_1, int type_2) { @@ -234,8 +244,11 @@ void BKE_curveprofile_selected_handle_set(CurveProfile *profile, int type_1, int } } -/** Flips the profile across the diagonal so that its orientation is reversed. - * \note: Requires curveprofile_update call after. */ +/** + * Flips the profile across the diagonal so that its orientation is reversed. + * + * \note Requires #BKE_curveprofile_update call after. + */ void BKE_curveprofile_reverse(CurveProfile *profile) { /* When there are only two points, reversing shouldn't do anything. */ @@ -258,7 +271,9 @@ void BKE_curveprofile_reverse(CurveProfile *profile) profile->path = new_pts; } -/** Builds a quarter circle profile with space on each side for 'support loops.' */ +/** + * Builds a quarter circle profile with space on each side for 'support loops.' + */ static void CurveProfile_build_supports(CurveProfile *profile) { int n = profile->path_len; @@ -292,7 +307,10 @@ static void CurveProfile_build_supports(CurveProfile *profile) profile->path[n - 1].h2 = HD_VECT; } -/** Puts the widget's control points in a step pattern. Uses vector handles for each point. */ +/** + * Puts the widget's control points in a step pattern. + * Uses vector handles for each point. + */ static void CurveProfile_build_steps(CurveProfile *profile) { int n, step_x, step_y; @@ -329,7 +347,9 @@ static void CurveProfile_build_steps(CurveProfile *profile) } } -/** Shorthand helper function for setting location and interpolation of a point. */ +/** + * Shorthand helper function for setting location and interpolation of a point. + */ static void point_init(CurveProfilePoint *point, float x, float y, short flag, char h1, char h2) { point->x = x; @@ -339,8 +359,11 @@ static void point_init(CurveProfilePoint *point, float x, float y, short flag, c point->h2 = h2; } -/** Resets the profile to the current preset. - * \note: Requires curveprofile_update call after. */ +/** + * Resets the profile to the current preset. + * + * \note Requires #BKE_curveprofile_update call after. + */ void BKE_curveprofile_reset(CurveProfile *profile) { if (profile->path) { @@ -429,15 +452,19 @@ void BKE_curveprofile_reset(CurveProfile *profile) } } -/** Helper for 'curve_profile_create' samples. Returns whether both handles that make up the edge - * are vector handles. */ +/** + * Helper for 'curve_profile_create' samples. + * Returns whether both handles that make up the edge are vector handles. + */ static bool is_curved_edge(BezTriple *bezt, int i) { return (bezt[i].h2 != HD_VECT || bezt[i + 1].h1 != HD_VECT); } -/** Used to set bezier handle locations in the sample creation process. Reduced copy of - * #calchandleNurb_intern code in curve.c. */ +/** + * Used to set bezier handle locations in the sample creation process. Reduced copy of + * #calchandleNurb_intern code in curve.c. + */ static void calchandle_profile(BezTriple *bezt, const BezTriple *prev, const BezTriple *next) { #define point_handle1 ((point_loc)-3) @@ -517,10 +544,12 @@ static void calchandle_profile(BezTriple *bezt, const BezTriple *prev, const Bez #undef point_handle2 } -/** Helper function for 'BKE_CurveProfile_create_samples.' Calculates the angle between the +/** + * Helper function for 'BKE_CurveProfile_create_samples.' Calculates the angle between the * handles on the inside of the edge starting at index i. A larger angle means the edge is * more curved. - * \param i_edge: The start index of the edge to calculate the angle for. */ + * \param i_edge: The start index of the edge to calculate the angle for. + */ static float bezt_edge_handle_angle(const BezTriple *bezt, int i_edge) { /* Find the direction of the handles that define this edge along the direction of the path. */ @@ -542,7 +571,9 @@ typedef struct { float bezt_curvature; } CurvatureSortPoint; -/** Helper function for 'BKE_curveprofile_create_samples' for sorting edges based on curvature. */ +/** + * Helper function for 'BKE_curveprofile_create_samples' for sorting edges based on curvature. + */ static int sort_points_curvature(const void *in_a, const void *in_b) { const CurvatureSortPoint *a = (const CurvatureSortPoint *)in_a; @@ -556,16 +587,19 @@ static int sort_points_curvature(const void *in_a, const void *in_b) } } -/** Used for sampling curves along the profile's path. Any points more than the number of user- - * defined points will be evenly distributed among the curved edges. Then the remainders will be - * distributed to the most curved edges. +/** + * Used for sampling curves along the profile's path. Any points more than the number of + * user-defined points will be evenly distributed among the curved edges. + * Then the remainders will be distributed to the most curved edges. + * * \param n_segments: The number of segments to sample along the path. It must be higher than the - * number of points used to define the profile (profile->path_len). + * number of points used to define the profile (profile->path_len). * \param sample_straight_edges: Whether to sample points between vector handle control points. If - * this is true and there are only vector edges the straight edges will still be sampled. + * this is true and there are only vector edges the straight edges will still be sampled. * \param r_samples: An array of points to put the sampled positions. Must have length n_segments. * \return r_samples: Fill the array with the sampled locations and if the point corresponds - * to a control point, its handle type */ + * to a control point, its handle type + */ void BKE_curveprofile_create_samples(CurveProfile *profile, int n_segments, bool sample_straight_edges, @@ -726,8 +760,10 @@ void BKE_curveprofile_create_samples(CurveProfile *profile, MEM_freeN(n_samples); } -/** Creates a higher resolution table by sampling the curved points. This table is used for display - * and evenly spaced evaluation. */ +/** + * Creates a higher resolution table by sampling the curved points. + * This table is used for display and evenly spaced evaluation. + */ static void curveprofile_make_table(CurveProfile *profile) { int n_samples = PROF_N_TABLE(profile->path_len); @@ -745,8 +781,10 @@ static void curveprofile_make_table(CurveProfile *profile) profile->table = new_table; } -/** Creates the table of points used for displaying a preview of the sampled segment locations on - * the widget itself. */ +/** + * Creates the table of points used for displaying a preview of the sampled segment locations on + * the widget itself. + */ static void CurveProfile_make_segments_table(CurveProfile *profile) { int n_samples = profile->segments_len; @@ -771,8 +809,10 @@ static void CurveProfile_make_segments_table(CurveProfile *profile) profile->segments = new_table; } -/** Sets the default settings and clip range for the profile widget. Does not generate either - * table. */ +/** + * Sets the default settings and clip range for the profile widget. + * Does not generate either table. + */ void BKE_curveprofile_set_defaults(CurveProfile *profile) { profile->flag = PROF_USE_CLIP; @@ -791,8 +831,10 @@ void BKE_curveprofile_set_defaults(CurveProfile *profile) profile->changed_timestamp = 0; } -/** Returns a pointer to a newly allocated curve profile, using the given preset. - \param preset: Value in eCurveProfilePresets. */ +/** + * Returns a pointer to a newly allocated curve profile, using the given preset. + * \param preset: Value in #eCurveProfilePresets. + */ struct CurveProfile *BKE_curveprofile_add(int preset) { CurveProfile *profile = MEM_callocN(sizeof(CurveProfile), "curve profile"); @@ -805,8 +847,10 @@ struct CurveProfile *BKE_curveprofile_add(int preset) return profile; } -/** Should be called after the widget is changed. Does profile and remove double checks and more - * importantly, recreates the display / evaluation and segments tables. */ +/** + * Should be called after the widget is changed. Does profile and remove double checks and more + * importantly, recreates the display / evaluation and segments tables. + */ void BKE_curveprofile_update(CurveProfile *profile, const bool remove_double) { CurveProfilePoint *points = profile->path; @@ -873,9 +917,12 @@ void BKE_curveprofile_update(CurveProfile *profile, const bool remove_double) } } -/** Refreshes the higher resolution table sampled from the input points. A call to this or - * curveprofile_update is needed before evaluation functions that use the table. Also sets the - * number of segments used for the display preview of the locations of the sampled points. */ +/** + * Refreshes the higher resolution table sampled from the input points. A call to this or + * #BKE_curveprofile_update is needed before evaluation functions that use the table. + * Also sets the number of segments used for the display preview of the locations + * of the sampled points. + */ void BKE_curveprofile_initialize(CurveProfile *profile, short segments_len) { profile->segments_len = segments_len; @@ -884,9 +931,12 @@ void BKE_curveprofile_initialize(CurveProfile *profile, short segments_len) BKE_curveprofile_update(profile, false); } -/** Gives the distance to the next point in the widget's sampled table, in other words the length +/** + * Gives the distance to the next point in the widget's sampled table, in other words the length * of the ith edge of the table. - * \note Requires curveprofile_initialize or curveprofile_update call before to fill table. */ + * + * \note Requires curveprofile_initialize or #BKE_curveprofile_update call before to fill table. + */ static float curveprofile_distance_to_next_table_point(const CurveProfile *profile, int i) { BLI_assert(i < PROF_N_TABLE(profile->path_len)); @@ -894,8 +944,11 @@ static float curveprofile_distance_to_next_table_point(const CurveProfile *profi return len_v2v2(&profile->table[i].x, &profile->table[i + 1].x); } -/** Calculates the total length of the profile from the curves sampled in the table. - * \note Requires curveprofile_initialize or curveprofile_update call before to fill table. */ +/** + * Calculates the total length of the profile from the curves sampled in the table. + * + * \note Requires curveprofile_initialize or #BKE_curveprofile_update call before to fill table. + */ float BKE_curveprofile_total_length(const CurveProfile *profile) { float total_length = 0; @@ -905,11 +958,14 @@ float BKE_curveprofile_total_length(const CurveProfile *profile) return total_length; } -/** Samples evenly spaced positions along the curve profile's table (generated from path). Fills +/** + * Samples evenly spaced positions along the curve profile's table (generated from path). Fills * an entire table at once for a speedup if all of the results are going to be used anyway. - * \note Requires curveprofile_initialize or curveprofile_update call before to fill table. + * + * \note Requires curveprofile_initialize or #BKE_curveprofile_update call before to fill table. * \note Working, but would conflict with "Sample Straight Edges" option, so this is unused for - * now. */ + * now. + */ void BKE_curveprofile_create_samples_even_spacing(CurveProfile *profile, int n_segments, CurveProfilePoint *r_samples) @@ -964,10 +1020,13 @@ void BKE_curveprofile_create_samples_even_spacing(CurveProfile *profile, } } -/** Does a single evaluation along the profile's path. Travels down (length_portion * path) length - * and returns the position at that point. +/** + * Does a single evaluation along the profile's path. + * Travels down (length_portion * path) length and returns the position at that point. + * * \param length_portion: The portion (0 to 1) of the path's full length to sample at. - * \note Requires curveprofile_initialize or curveprofile_update call before to fill table */ + * \note Requires curveprofile_initialize or #BKE_curveprofile_update call before to fill table. + */ void BKE_curveprofile_evaluate_length_portion(const CurveProfile *profile, float length_portion, float *x_out, diff --git a/source/blender/blenkernel/intern/font.c b/source/blender/blenkernel/intern/font.c index aac3e8cc7fc..47b6fbfb4f8 100644 --- a/source/blender/blenkernel/intern/font.c +++ b/source/blender/blenkernel/intern/font.c @@ -1634,8 +1634,10 @@ bool BKE_vfont_to_curve_nubase(Object *ob, int mode, ListBase *r_nubase) return BKE_vfont_to_curve_ex(ob, ob->data, mode, r_nubase, NULL, NULL, NULL, NULL); } -/** Warning: expects to have access to evaluated data - * (i.e. passed object should be evaluated one...). */ +/** + * Warning: expects to have access to evaluated data + * (i.e. passed object should be evaluated one...). + */ bool BKE_vfont_to_curve(Object *ob, int mode) { Curve *cu = ob->data; diff --git a/source/blender/blenkernel/intern/gpencil.c b/source/blender/blenkernel/intern/gpencil.c index c51668ea68c..d0da5c6c0f1 100644 --- a/source/blender/blenkernel/intern/gpencil.c +++ b/source/blender/blenkernel/intern/gpencil.c @@ -1140,7 +1140,8 @@ int BKE_gpencil_object_material_ensure(Main *bmain, Object *ob, Material *materi return index; } -/** Creates a new gpencil material and assigns it to object. +/** + * Creates a new gpencil material and assigns it to object. * * \param *r_index: value is set to zero based index of the new material if r_index is not NULL */ diff --git a/source/blender/blenkernel/intern/icons.c b/source/blender/blenkernel/intern/icons.c index 90dba4bc737..7b8a0a8894f 100644 --- a/source/blender/blenkernel/intern/icons.c +++ b/source/blender/blenkernel/intern/icons.c @@ -468,8 +468,10 @@ void BKE_previewimg_cached_release(const char *name) BKE_previewimg_cached_release_pointer(prv); } -/** Handle deferred (lazy) loading/generation of preview image, if needed. - * For now, only used with file thumbnails. */ +/** + * Handle deferred (lazy) loading/generation of preview image, if needed. + * For now, only used with file thumbnails. + */ void BKE_previewimg_ensure(PreviewImage *prv, const int size) { if ((prv->tag & PRV_TAG_DEFFERED) != 0) { diff --git a/source/blender/blenkernel/intern/key.c b/source/blender/blenkernel/intern/key.c index 9a38f348361..6e8677b5422 100644 --- a/source/blender/blenkernel/intern/key.c +++ b/source/blender/blenkernel/intern/key.c @@ -2256,7 +2256,8 @@ void BKE_keyblock_update_from_offset(Object *ob, KeyBlock *kb, const float (*ofs /* ==========================================================*/ -/** Move shape key from org_index to new_index. Safe, clamps index to valid range, +/** + * Move shape key from org_index to new_index. Safe, clamps index to valid range, * updates reference keys, 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). diff --git a/source/blender/blenkernel/intern/library.c b/source/blender/blenkernel/intern/library.c index 909db9c7b52..e312522b508 100644 --- a/source/blender/blenkernel/intern/library.c +++ b/source/blender/blenkernel/intern/library.c @@ -797,8 +797,10 @@ bool BKE_id_copy(Main *bmain, const ID *id, ID **newid) return BKE_id_copy_ex(bmain, id, newid, LIB_ID_COPY_DEFAULT); } -/** Does a mere memory swap over the whole IDs data (including type-specific memory). - * \note Most internal ID data itself is not swapped (only IDProperties are). */ +/** + * Does a mere memory swap over the whole IDs data (including type-specific memory). + * \note Most internal ID data itself is not swapped (only IDProperties are). + */ void BKE_id_swap(Main *bmain, ID *id_a, ID *id_b) { BLI_assert(GS(id_a->name) == GS(id_b->name)); @@ -1380,9 +1382,11 @@ void BKE_libblock_init_empty(ID *id) } } -/** Generic helper to create a new empty data-block of given type in given \a bmain database. +/** + * Generic helper to create a new empty data-block of given type in given \a bmain database. * - * \param name: can be NULL, in which case we get default name for this ID type. */ + * \param name: can be NULL, in which case we get default name for this ID type. + */ void *BKE_id_new(Main *bmain, const short type, const char *name) { BLI_assert(bmain != NULL); @@ -1936,7 +1940,8 @@ static void library_make_local_copying_check(ID *id, BLI_gset_remove(loop_tags, id, NULL); } -/** Make linked data-blocks local. +/** + * Make linked data-blocks local. * * \param bmain: Almost certainly global main. * \param lib: If not NULL, only make local data-blocks from this library. @@ -2363,8 +2368,10 @@ void BKE_id_tag_clear_atomic(ID *id, int tag) atomic_fetch_and_and_int32(&id->tag, ~tag); } -/** Check that given ID pointer actually is in G_MAIN. - * Main intended use is for debug asserts in places we cannot easily get rid of G_Main... */ +/** + * Check that given ID pointer actually is in G_MAIN. + * Main intended use is for debug asserts in places we cannot easily get rid of G_Main... + */ bool BKE_id_is_in_global_main(ID *id) { /* We do not want to fail when id is NULL here, even though this is a bit strange behavior... diff --git a/source/blender/blenkernel/intern/library_override.c b/source/blender/blenkernel/intern/library_override.c index ae6d1c26a2b..2e958c8a578 100644 --- a/source/blender/blenkernel/intern/library_override.c +++ b/source/blender/blenkernel/intern/library_override.c @@ -221,7 +221,8 @@ ID *BKE_override_library_create_from_id(Main *bmain, ID *reference_id, const boo return local_id; } -/** Create overridden local copies of all tagged data-blocks in given Main. +/** + * Create overridden local copies of all tagged data-blocks in given Main. * * \note Set id->newid of overridden libs with newly created overrides, * caller is responsible to clean those pointers before/after usage as needed. diff --git a/source/blender/blenkernel/intern/library_remap.c b/source/blender/blenkernel/intern/library_remap.c index be283c68911..e1b3212a92c 100644 --- a/source/blender/blenkernel/intern/library_remap.c +++ b/source/blender/blenkernel/intern/library_remap.c @@ -636,7 +636,8 @@ void BKE_libblock_unlink(Main *bmain, BKE_main_unlock(bmain); } -/** Similar to libblock_remap, but only affects IDs used by given \a idv ID. +/** + * Similar to libblock_remap, but only affects IDs used by given \a idv ID. * * \param old_idv: Unlike BKE_libblock_remap, can be NULL, * in which case all ID usages by given \a idv will be cleared. diff --git a/source/blender/blenkernel/intern/mball.c b/source/blender/blenkernel/intern/mball.c index b127d5d4d0e..c5cb95927ec 100644 --- a/source/blender/blenkernel/intern/mball.c +++ b/source/blender/blenkernel/intern/mball.c @@ -178,7 +178,8 @@ MetaElem *BKE_mball_element_add(MetaBall *mb, const int type) return ml; } -/** Compute bounding box of all MetaElems/MetaBalls. +/** + * Compute bounding box of all MetaElems/MetaBalls. * * Bounding box is computed from polygonized surface. Object *ob is * basic MetaBall (usually with name Meta). All other MetaBalls (with diff --git a/source/blender/blenkernel/intern/mesh_evaluate.c b/source/blender/blenkernel/intern/mesh_evaluate.c index 7a1dcb4a5fd..2b3051b766a 100644 --- a/source/blender/blenkernel/intern/mesh_evaluate.c +++ b/source/blender/blenkernel/intern/mesh_evaluate.c @@ -915,7 +915,8 @@ static void mesh_edges_sharp_tag(LoopSplitTaskDataCommon *data, } } -/** Define sharp edges as needed to mimic 'autosmooth' from angle threshold. +/** + * Define sharp edges as needed to mimic 'autosmooth' from angle threshold. * * Used when defining an empty custom loop normals data layer, * to keep same shading as with autosmooth! diff --git a/source/blender/blenkernel/intern/object.c b/source/blender/blenkernel/intern/object.c index b50e152527e..2f7bd27445a 100644 --- a/source/blender/blenkernel/intern/object.c +++ b/source/blender/blenkernel/intern/object.c @@ -1462,7 +1462,8 @@ Object *BKE_object_copy(Main *bmain, const Object *ob) return ob_copy; } -/** Perform deep-copy of object and its 'children' data-blocks (obdata, materials, actions, etc.). +/** + * Perform deep-copy of object and its 'children' data-blocks (obdata, materials, actions, etc.). * * \param dupflag: Controls which sub-data are also duplicated * (see #eDupli_ID_Flags in DNA_userdef_types.h). diff --git a/source/blender/blenkernel/intern/scene.c b/source/blender/blenkernel/intern/scene.c index 2753cbd9be2..9dcebbba56e 100644 --- a/source/blender/blenkernel/intern/scene.c +++ b/source/blender/blenkernel/intern/scene.c @@ -1433,7 +1433,8 @@ void BKE_scene_graph_update_for_newframe(Depsgraph *depsgraph, Main *bmain) } } -/** Ensures given scene/view_layer pair has a valid, up-to-date depsgraph. +/** + * Ensures given scene/view_layer pair has a valid, up-to-date depsgraph. * * \warning Sets matching depsgraph as active, * so should only be called from the active editing context (usually, from operators). diff --git a/source/blender/blenkernel/intern/screen.c b/source/blender/blenkernel/intern/screen.c index 1835fb2a523..5e19a60dfa2 100644 --- a/source/blender/blenkernel/intern/screen.c +++ b/source/blender/blenkernel/intern/screen.c @@ -756,7 +756,7 @@ ARegion *BKE_screen_find_region_xy(bScreen *sc, const int regiontype, int x, int } /** - * \note, ideally we can get the area from the context, + * \note Ideally we can get the area from the context, * there are a few places however where this isn't practical. */ ScrArea *BKE_screen_find_area_from_space(struct bScreen *sc, SpaceLink *sl) diff --git a/source/blender/blenkernel/intern/studiolight.c b/source/blender/blenkernel/intern/studiolight.c index ff92704e2d1..a02ff98a38a 100644 --- a/source/blender/blenkernel/intern/studiolight.c +++ b/source/blender/blenkernel/intern/studiolight.c @@ -85,7 +85,9 @@ static const char *STUDIOLIGHT_MATCAP_DEFAULT = "basic_1.exr"; /* ITER MACRO */ -/** Iter on all pixel giving texel center position and pixel pointer. +/** + * Iter on all pixel giving texel center position and pixel pointer. + * * Arguments * type : type of src. * src : source buffer. diff --git a/source/blender/blenkernel/intern/undo_system.c b/source/blender/blenkernel/intern/undo_system.c index ecae1650a51..36a58a6ca02 100644 --- a/source/blender/blenkernel/intern/undo_system.c +++ b/source/blender/blenkernel/intern/undo_system.c @@ -50,8 +50,10 @@ /** Make sure all ID's created at the point we add an undo step that uses ID's. */ #define WITH_GLOBAL_UNDO_ENSURE_UPDATED -/** Make sure we don't apply edits on top of a newer memfile state, see: T56163. - * \note Keep an eye on this, could solve differently. */ +/** + * Make sure we don't apply edits on top of a newer memfile state, see: T56163. + * \note Keep an eye on this, could solve differently. + */ #define WITH_GLOBAL_UNDO_CORRECT_ORDER /** We only need this locally. */ diff --git a/source/blender/blenlib/BLI_array.h b/source/blender/blenlib/BLI_array.h index 57e1790fdfd..5b85711f8ac 100644 --- a/source/blender/blenlib/BLI_array.h +++ b/source/blender/blenlib/BLI_array.h @@ -42,7 +42,8 @@ /** \} */ -/** BLI_array.c +/** + * BLI_array.c * * Doing the realloc in a macro isn't so simple, * so use a function the macros can use. diff --git a/source/blender/blenlib/BLI_rand.h b/source/blender/blenlib/BLI_rand.h index eec4e885493..be2b18b05fd 100644 --- a/source/blender/blenlib/BLI_rand.h +++ b/source/blender/blenlib/BLI_rand.h @@ -72,9 +72,9 @@ void BLI_array_frand(float *ar, int count, unsigned int seed); /** Return a pseudo-random (hash) float from an integer value */ float BLI_hash_frand(unsigned int seed) ATTR_WARN_UNUSED_RESULT; -/** Shuffle an array randomly using the given seed. - * contents. This routine does not use nor modify - * the state of the BLI random number generator. +/** + * Shuffle an array randomly using the given seed contents. + * This routine does not use nor modify the state of the BLI random number generator. */ void BLI_array_randomize(void *data, unsigned int elem_size, diff --git a/source/blender/blenlib/BLI_voxel.h b/source/blender/blenlib/BLI_voxel.h index 2a02eb380b5..ef210a82a65 100644 --- a/source/blender/blenlib/BLI_voxel.h +++ b/source/blender/blenlib/BLI_voxel.h @@ -24,7 +24,7 @@ * \ingroup bli */ -/** find the index number of a voxel, given x/y/z integer coords and resolution vector */ +/** Find the index number of a voxel, given x/y/z integer coords and resolution vector. */ #define BLI_VOXEL_INDEX(x, y, z, res) \ ((int64_t)(x) + (int64_t)(y) * (int64_t)(res)[0] + \ diff --git a/source/blender/blenlib/intern/delaunay_2d.c b/source/blender/blenlib/intern/delaunay_2d.c index 9c1e52b53a4..27f7a2a4430 100644 --- a/source/blender/blenlib/intern/delaunay_2d.c +++ b/source/blender/blenlib/intern/delaunay_2d.c @@ -115,8 +115,10 @@ static void validate_face_centroid(SymEdge *se); static void validate_cdt(CDT_state *cdt, bool check_all_tris); #endif -/** return 1 if a,b,c forms CCW angle, -1 if a CW angle, 0 if straight. - * For straight test, allow b to be withing eps of line. */ +/** + * Return 1 if a,b,c forms CCW angle, -1 if a CW angle, 0 if straight. + * For straight test, allow b to be withing eps of line. + */ static int CCW_test(const double a[2], const double b[2], const double c[2], const double eps) { double det; @@ -902,7 +904,8 @@ static LocateResult locate_point(CDT_state *cdt, const double p[2]) return lr; } -/** Return true if circumcircle(v1, v2, v3) does not contain p. +/** + * Return true if circumcircle(v1, v2, v3) does not contain p. * To avoid possible infinite flip loops, we will say true even if p is inside the circle * but less than epsilon from the boundary; or if v1, v2, v3, form a straight line. */ diff --git a/source/blender/blenlib/intern/hash_md5.c b/source/blender/blenlib/intern/hash_md5.c index f9e9b3bfbf9..5ec1c91a735 100644 --- a/source/blender/blenlib/intern/hash_md5.c +++ b/source/blender/blenlib/intern/hash_md5.c @@ -94,8 +94,9 @@ struct md5_ctx { * (RFC 1321, 3.1: Step 1) */ static const unsigned char fillbuf[64] = {0x80, 0 /* , 0, 0, ... */}; -/** Initialize structure containing state of computation. - * (RFC 1321, 3.3: Step 3) +/** + * Initialize structure containing state of computation. + * (RFC 1321, 3.3: Step 3) */ static void md5_init_ctx(struct md5_ctx *ctx) { @@ -283,8 +284,9 @@ static void *md5_read_ctx(const struct md5_ctx *ctx, void *resbuf) /* Top level public functions. */ -/** Compute MD5 message digest for bytes read from 'stream'. - * The resulting message digest number will be written into the 16 bytes beginning at 'resblock'. +/** + * Compute MD5 message digest for bytes read from 'stream'. + * The resulting message digest number will be written into the 16 bytes beginning at 'resblock'. * \return Non-zero if an error occurred. */ int BLI_hash_md5_stream(FILE *stream, void *resblock) diff --git a/source/blender/blenlib/intern/kdtree_impl.h b/source/blender/blenlib/intern/kdtree_impl.h index 32e8a4e90f5..404e136a0a6 100644 --- a/source/blender/blenlib/intern/kdtree_impl.h +++ b/source/blender/blenlib/intern/kdtree_impl.h @@ -58,8 +58,10 @@ struct KDTree { #define KD_NODE_UNSET ((uint)-1) -/** When set we know all values are unbalanced, - * otherwise clear them when re-balancing: see T62210. */ +/** + * When set we know all values are unbalanced, + * otherwise clear them when re-balancing: see T62210. + */ #define KD_NODE_ROOT_IS_INIT ((uint)-2) /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenlib/intern/math_base_inline.c b/source/blender/blenlib/intern/math_base_inline.c index 0309876d8fb..4c86b9d3396 100644 --- a/source/blender/blenlib/intern/math_base_inline.c +++ b/source/blender/blenlib/intern/math_base_inline.c @@ -526,15 +526,19 @@ MINLINE int signum_i(float a) } } -/** Returns number of (base ten) *significant* digits of integer part of given float - * (negative in case of decimal-only floats, 0.01 returns -1 e.g.). */ +/** + * Returns number of (base ten) *significant* digits of integer part of given float + * (negative in case of decimal-only floats, 0.01 returns -1 e.g.). + */ MINLINE int integer_digits_f(const float f) { return (f == 0.0f) ? 0 : (int)floor(log10(fabs(f))) + 1; } -/** Returns number of (base ten) *significant* digits of integer part of given double - * (negative in case of decimal-only floats, 0.01 returns -1 e.g.). */ +/** + * Returns number of (base ten) *significant* digits of integer part of given double + * (negative in case of decimal-only floats, 0.01 returns -1 e.g.). + */ MINLINE int integer_digits_d(const double d) { return (d == 0.0) ? 0 : (int)floor(log10(fabs(d))) + 1; diff --git a/source/blender/blenlib/intern/math_geom.c b/source/blender/blenlib/intern/math_geom.c index 67ef4d57b4b..27715ed49b5 100644 --- a/source/blender/blenlib/intern/math_geom.c +++ b/source/blender/blenlib/intern/math_geom.c @@ -2996,8 +2996,9 @@ int isect_line_line_v3(const float v1[3], return isect_line_line_epsilon_v3(v1, v2, v3, v4, r_i1, r_i2, epsilon); } -/** Intersection point strictly between the two lines - * \return false when no intersection is found +/** + * Intersection point strictly between the two lines + * \return false when no intersection is found. */ bool isect_line_line_strict_v3(const float v1[3], const float v2[3], @@ -3188,7 +3189,7 @@ bool isect_ray_aabb_v3(const struct IsectRayAABB_Precalc *data, * Test a bounding box (AABB) for ray intersection. * Assumes the ray is already local to the boundbox space. * - * \note: \a direction should be normalized + * \note \a direction should be normalized * if you intend to use the \a tmin or \a tmax distance results! */ bool isect_ray_aabb_v3_simple(const float orig[3], @@ -3791,7 +3792,7 @@ bool barycentric_coords_v2( } /** - * \note: using #cross_tri_v2 means locations outside the triangle are correctly weighted + * \note Using #cross_tri_v2 means locations outside the triangle are correctly weighted. * * \note This is *exactly* the same calculation as #resolve_tri_uv_v2, * although it has double precision and is used for texture baking, so keep both. diff --git a/source/blender/blenlib/intern/math_matrix.c b/source/blender/blenlib/intern/math_matrix.c index 48884082dd8..5118d8a698e 100644 --- a/source/blender/blenlib/intern/math_matrix.c +++ b/source/blender/blenlib/intern/math_matrix.c @@ -1964,8 +1964,10 @@ void mat4_to_size(float size[3], const float mat[4][4]) size[2] = len_v3(mat[2]); } -/** Extract scale factors from the matrix, with correction to ensure - * exact volume in case of a sheared matrix. */ +/** + * Extract scale factors from the matrix, with correction to ensure + * exact volume in case of a sheared matrix. + */ void mat4_to_size_fix_shear(float size[3], const float mat[4][4]) { mat4_to_size(size, mat); diff --git a/source/blender/blenlib/intern/math_rotation.c b/source/blender/blenlib/intern/math_rotation.c index 37c0c05b061..94f0f523c6e 100644 --- a/source/blender/blenlib/intern/math_rotation.c +++ b/source/blender/blenlib/intern/math_rotation.c @@ -77,7 +77,7 @@ void mul_qt_qtqt(float q[4], const float q1[4], const float q2[4]) } /** - * \note: + * \note * Assumes a unit quaternion? * * in fact not, but you may want to use a unit quat, read on... @@ -93,7 +93,7 @@ void mul_qt_qtqt(float q[4], const float q1[4], const float q2[4]) * For people used to python mathutils, its like: * def mul_qt_v3(q, v): (q * Quaternion((0.0, v[0], v[1], v[2])) * q.conjugated())[1:] * - * \note: multiplying by 3x3 matrix is ~25% faster. + * \note Multiplying by 3x3 matrix is ~25% faster. */ void mul_qt_v3(const float q[4], float v[3]) { diff --git a/source/blender/blenlib/intern/path_util.c b/source/blender/blenlib/intern/path_util.c index 725b6f8937a..dff1f77c1ab 100644 --- a/source/blender/blenlib/intern/path_util.c +++ b/source/blender/blenlib/intern/path_util.c @@ -57,8 +57,10 @@ #ifdef WIN32 -/** Return true if the path is absolute ie starts with a drive specifier - * (eg A:\) or is a UNC path. */ +/** + * Return true if the path is absolute ie starts with a drive specifier + * (eg A:\) or is a UNC path. + */ static bool BLI_path_is_abs(const char *name); #endif /* WIN32 */ @@ -444,8 +446,10 @@ static int BLI_path_unc_prefix_len(const char *path) #if defined(WIN32) -/** Return true if the path is absolute ie starts with a drive specifier - * (eg A:\) or is a UNC path. */ +/** + * Return true if the path is absolute ie starts with a drive specifier + * (eg A:\) or is a UNC path. + */ static bool BLI_path_is_abs(const char *name) { return (name[1] == ':' && (name[2] == '\\' || name[2] == '/')) || BLI_path_is_unc(name); diff --git a/source/blender/bmesh/intern/bmesh_core.c b/source/blender/bmesh/intern/bmesh_core.c index 68b30912041..f795783d161 100644 --- a/source/blender/bmesh/intern/bmesh_core.c +++ b/source/blender/bmesh/intern/bmesh_core.c @@ -363,7 +363,7 @@ BMFace *BM_face_copy( * only create the face, since this calloc's the length is initialized to 0, * leave adding loops to the caller. * - * \note, caller needs to handle customdata. + * \note Caller needs to handle customdata. */ BLI_INLINE BMFace *bm_face_create__internal(BMesh *bm) { diff --git a/source/blender/bmesh/intern/bmesh_mesh.c b/source/blender/bmesh/intern/bmesh_mesh.c index 4790c811e56..15de281ded4 100644 --- a/source/blender/bmesh/intern/bmesh_mesh.c +++ b/source/blender/bmesh/intern/bmesh_mesh.c @@ -1108,7 +1108,8 @@ void BM_loops_calc_normal_vcos(BMesh *bm, } } -/** Define sharp edges as needed to mimic 'autosmooth' from angle threshold. +/** + * Define sharp edges as needed to mimic 'autosmooth' from angle threshold. * * Used when defining an empty custom loop normals data layer, * to keep same shading as with autosmooth! diff --git a/source/blender/bmesh/operators/bmo_subdivide_edgering.c b/source/blender/bmesh/operators/bmo_subdivide_edgering.c index a193275ef52..f93d33bb05f 100644 --- a/source/blender/bmesh/operators/bmo_subdivide_edgering.c +++ b/source/blender/bmesh/operators/bmo_subdivide_edgering.c @@ -212,7 +212,7 @@ static GSet *bm_edgering_pair_calc(BMesh *bm, ListBase *eloops_rim) * - use the edge-verts and (vert -> eloop) map * to create a pair of eloop pointers, add these to a hash. * - * \note, each loop pair will be found twice. + * \note Each loop pair will be found twice. * could sort and optimize this but not really so important. */ diff --git a/source/blender/bmesh/tools/bmesh_bevel.c b/source/blender/bmesh/tools/bmesh_bevel.c index e2f098d72f3..9cc645f7a3a 100644 --- a/source/blender/bmesh/tools/bmesh_bevel.c +++ b/source/blender/bmesh/tools/bmesh_bevel.c @@ -161,10 +161,12 @@ typedef struct Profile { #define PRO_LINE_R 1.0f #define PRO_SQUARE_IN_R 0.0f -/** The un-transformed 2D storage of profile vertex locations. Also for non-custom profiles +/** + * The un-transformed 2D storage of profile vertex locations. Also for non-custom profiles * this serves as a cache for the results of the expensive calculation of u parameter values to * get even spacing on superellipse for current BevelParams seg - * and pro_super_r. */ + * and pro_super_r. + */ typedef struct ProfileSpacing { /** The profile's seg+1 x values */ double *xvals; @@ -3022,14 +3024,18 @@ static bool adjust_the_cycle_or_chain_fast(BoundVert *vstart, int np, bool iscyc } #endif -/** Helper function to return the next Beveled EdgeHalf along a path. - * \param toward_bv Whether the direction to travel points toward or away from the BevVert - * connected to the current EdgeHalf - * \param r_bv The BevVert connected to the EdgeHalf-- updated if we're traveling to the other - * EdgeHalf of an original edge +/** + * Helper function to return the next Beveled EdgeHalf along a path. + * + * \param toward_bv: Whether the direction to travel points toward or away from the BevVert + * connected to the current EdgeHalf. + * \param r_bv: The BevVert connected to the EdgeHalf -- updated if we're traveling to the other + * EdgeHalf of an original edge. + * * \note This only returns the most parallel edge if it's the most parallel by * at least 10 degrees. This is a somewhat arbitrary choice, but it makes sure that consistent - * orientation paths only continue in obvious ways. */ + * orientation paths only continue in obvious ways. + */ static EdgeHalf *next_edgehalf_bev(BevelParams *bp, EdgeHalf *start_edge, bool toward_bv, @@ -3115,10 +3121,12 @@ static EdgeHalf *next_edgehalf_bev(BevelParams *bp, } } -/** Starting along any beveled edge, travel along the chain / cycle of beveled edges including that +/** + * Starting along any beveled edge, travel along the chain / cycle of beveled edges including that * edge, marking consistent profile orientations along the way. Orientations are marked by setting * whether the BoundVert that contains each profile's information is the side of the profile's - * start or not. */ + * start or not. + */ static void regularize_profile_orientation(BevelParams *bp, BMEdge *bme) { BevVert *start_bv; @@ -3166,10 +3174,12 @@ static void regularize_profile_orientation(BevelParams *bp, BMEdge *bme) } #ifdef DEBUG_PROFILE_ORIENTATION_DRAW -/** Draws markers on beveled edges showing the side that the profile starts on. A sphere shows +/** + * Draws markers on beveled edges showing the side that the profile starts on. A sphere shows * the start side of the profile where it starts, and the lines connected to the sphere show which * edge the orientation corresponds to. - * \note Only drawn while bevel is calculating, the debug geometry is not persistent. */ + * \note Only drawn while bevel is calculating, the debug geometry is not persistent. + */ static void debug_draw_profile_orientation(BevelParams *bp, BMesh *bm) { BMIter iter; @@ -4365,9 +4375,11 @@ static void snap_to_pipe_profile(BoundVert *vpipe, bool midline, float co[3]) } } -/** See pipe_test for conditions that make 'pipe'; vpipe is the return value from that. +/** + * See pipe_test for conditions that make 'pipe'; vpipe is the return value from that. * We want to make an ADJ mesh but then snap the vertices to the profile in a plane - * perpendicular to the pipes. */ + * perpendicular to the pipes. + */ static VMesh *pipe_adj_vmesh(BevelParams *bp, BevVert *bv, BoundVert *vpipe) { #ifdef DEBUG_CUSTOM_PROFILE_PIPE @@ -5066,14 +5078,17 @@ static void bevel_build_rings(BevelParams *bp, BMesh *bm, BevVert *bv, BoundVert } } -/** Builds the vertex mesh when the vertex mesh type is set to "cut off" with a face closing - * off each incoming edge's profile */ -/* HANS-TODO: Make cutoff VMesh work with outer miter != sharp. This should be possible but there +/** + * Builds the vertex mesh when the vertex mesh type is set to "cut off" with a face closing + * off each incoming edge's profile. + * + * TODO(Hans): Make cutoff VMesh work with outer miter != sharp. This should be possible but there * are two problems currently: * - Miter profiles don't have plane_no filled, so down direction is incorrect. * - Indexing profile points of miters with (i, 0, k) seems to return zero except for the first - * and last profile point. */ -/* HANS-TODO: Use repface / edge arrays for UV interpolation properly. */ + * and last profile point. + * TODO(Hans): Use repface / edge arrays for UV interpolation properly. + */ static void bevel_build_cutoff(BevelParams *bp, BMesh *bm, BevVert *bv) { #ifdef DEBUG_CUSTOM_PROFILE_CUTOFF @@ -6905,9 +6920,11 @@ static void find_even_superellipse_chords(int n, float r, double *xvals, double find_even_superellipse_chords_general(n, r, xvals, yvals); } -/** Find the profile's "fullness," which is the fraction of the space it takes up way from the +/** + * Find the profile's "fullness," which is the fraction of the space it takes up way from the * boundvert's centroid to the original vertex for a non-custom profile, or in the case of a - * custom profile, the average "height" of the profile points along its centerline. */ + * custom profile, the average "height" of the profile points along its centerline. + */ static float find_profile_fullness(BevelParams *bp) { float fullness; @@ -6958,14 +6975,16 @@ static float find_profile_fullness(BevelParams *bp) return fullness; } -/** Fills the ProfileSpacing struct with the 2D coordinates for the profile's vertices. +/** + * Fills the ProfileSpacing struct with the 2D coordinates for the profile's vertices. * The superellipse used for multisegment profiles does not have a closed-form way * to generate evenly spaced points along an arc. We use an expensive search procedure * to find the parameter values that lead to bp->seg even chords. * We also want spacing for a number of segments that is a power of 2 >= bp->seg (but at least 4). * Use doubles because otherwise we cannot come close to float precision for final results. + * * \param pro_spacing: The struct to fill. Changes depending on whether there needs - to be a separate miter profile. */ + * to be a separate miter profile. */ static void set_profile_spacing(BevelParams *bp, ProfileSpacing *pro_spacing, bool custom) { int seg, seg_2; diff --git a/source/blender/bmesh/tools/bmesh_decimate_collapse.c b/source/blender/bmesh/tools/bmesh_decimate_collapse.c index 198b4c8e76b..56febf12e71 100644 --- a/source/blender/bmesh/tools/bmesh_decimate_collapse.c +++ b/source/blender/bmesh/tools/bmesh_decimate_collapse.c @@ -60,8 +60,10 @@ #endif #define BOUNDARY_PRESERVE_WEIGHT 100.0f -/** Uses double precision, impacts behavior on near-flat surfaces, - * cane give issues with very small faces. 1e-2 is too big, see: T48154. */ +/** + * Uses double precision, impacts behavior on near-flat surfaces, + * cane give issues with very small faces. 1e-2 is too big, see: T48154. + */ #define OPTIMIZE_EPS 1e-8 #define COST_INVALID FLT_MAX diff --git a/source/blender/collada/DocumentImporter.cpp b/source/blender/collada/DocumentImporter.cpp index 9d838406101..30e41a8d720 100644 --- a/source/blender/collada/DocumentImporter.cpp +++ b/source/blender/collada/DocumentImporter.cpp @@ -351,8 +351,10 @@ std::string DocumentImporter::get_import_version(const COLLADAFW::FileInfo *asse return ""; } -/** When this method is called, the writer must write the global document asset. - * \return The writer should return true, if writing succeeded, false otherwise.*/ +/** + * When this method is called, the writer must write the global document asset. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeGlobalAsset(const COLLADAFW::FileInfo *asset) { unit_converter.read_asset(asset); @@ -361,8 +363,10 @@ bool DocumentImporter::writeGlobalAsset(const COLLADAFW::FileInfo *asset) return true; } -/** When this method is called, the writer must write the scene. - * \return The writer should return true, if writing succeeded, false otherwise.*/ +/** + * When this method is called, the writer must write the scene. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeScene(const COLLADAFW::Scene *scene) { /* XXX could store the scene id, but do nothing for now */ @@ -742,9 +746,11 @@ bool DocumentImporter::writeVisualScene(const COLLADAFW::VisualScene *visualScen return true; } -/** When this method is called, the writer must handle all nodes contained in the +/** + * When this method is called, the writer must handle all nodes contained in the * library nodes. - * \return The writer should return true, if writing succeeded, false otherwise.*/ + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeLibraryNodes(const COLLADAFW::LibraryNodes *libraryNodes) { if (mImportStage == Fetching_Controller_data) { @@ -764,8 +770,10 @@ bool DocumentImporter::writeLibraryNodes(const COLLADAFW::LibraryNodes *libraryN return true; } -/** When this method is called, the writer must write the geometry. - * \return The writer should return true, if writing succeeded, false otherwise.*/ +/** + * When this method is called, the writer must write the geometry. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeGeometry(const COLLADAFW::Geometry *geom) { if (mImportStage == Fetching_Controller_data) { @@ -775,8 +783,10 @@ bool DocumentImporter::writeGeometry(const COLLADAFW::Geometry *geom) return mesh_importer.write_geometry(geom); } -/** When this method is called, the writer must write the material. - * \return The writer should return true, if writing succeeded, false otherwise.*/ +/** + * When this method is called, the writer must write the material. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeMaterial(const COLLADAFW::Material *cmat) { if (mImportStage == Fetching_Controller_data) { @@ -816,9 +826,10 @@ void DocumentImporter::write_profile_COMMON(COLLADAFW::EffectCommon *ef, Materia matNode.set_reflective(ef->getReflective()); } -/** When this method is called, the writer must write the effect. - * \return The writer should return true, if writing succeeded, false otherwise.*/ - +/** + * When this method is called, the writer must write the effect. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeEffect(const COLLADAFW::Effect *effect) { if (mImportStage == Fetching_Controller_data) { @@ -854,8 +865,10 @@ bool DocumentImporter::writeEffect(const COLLADAFW::Effect *effect) return true; } -/** When this method is called, the writer must write the camera. - * \return The writer should return true, if writing succeeded, false otherwise.*/ +/** + * When this method is called, the writer must write the camera. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeCamera(const COLLADAFW::Camera *camera) { if (mImportStage == Fetching_Controller_data) { @@ -965,8 +978,10 @@ bool DocumentImporter::writeCamera(const COLLADAFW::Camera *camera) return true; } -/** When this method is called, the writer must write the image. - * \return The writer should return true, if writing succeeded, false otherwise.*/ +/** + * When this method is called, the writer must write the image. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeImage(const COLLADAFW::Image *image) { if (mImportStage == Fetching_Controller_data) { @@ -1003,8 +1018,10 @@ bool DocumentImporter::writeImage(const COLLADAFW::Image *image) return true; } -/** When this method is called, the writer must write the light. - * \return The writer should return true, if writing succeeded, false otherwise.*/ +/** + * When this method is called, the writer must write the light. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeLight(const COLLADAFW::Light *light) { if (mImportStage == Fetching_Controller_data) { @@ -1188,8 +1205,10 @@ bool DocumentImporter::writeAnimationClip(const COLLADAFW::AnimationClip *animat } #endif -/** When this method is called, the writer must write the skin controller data. - * \return The writer should return true, if writing succeeded, false otherwise.*/ +/** + * When this method is called, the writer must write the skin controller data. + * \return The writer should return true, if writing succeeded, false otherwise. + */ bool DocumentImporter::writeSkinControllerData(const COLLADAFW::SkinControllerData *skin) { return armature_importer.write_skin_controller_data(skin); diff --git a/source/blender/compositor/intern/COM_ExecutionGroup.cpp b/source/blender/compositor/intern/COM_ExecutionGroup.cpp index 65c7429bb68..deb60836177 100644 --- a/source/blender/compositor/intern/COM_ExecutionGroup.cpp +++ b/source/blender/compositor/intern/COM_ExecutionGroup.cpp @@ -198,13 +198,13 @@ void ExecutionGroup::execute(ExecutionSystem *graph) const bNodeTree *bTree = context.getbNodeTree(); if (this->m_width == 0 || this->m_height == 0) { return; - } /// \note: break out... no pixels to calculate. + } /// \note Break out... no pixels to calculate. if (bTree->test_break && bTree->test_break(bTree->tbh)) { return; - } /// \note: early break out for blur and preview nodes + } /// \note Early break out for blur and preview nodes. if (this->m_numberOfChunks == 0) { return; - } /// \note: early break out + } /// \note Early break out. unsigned int chunkNumber; this->m_executionStartTime = PIL_check_seconds_timer(); diff --git a/source/blender/compositor/intern/COM_NodeGraph.cpp b/source/blender/compositor/intern/COM_NodeGraph.cpp index b4d6cc0ff60..6640f144518 100644 --- a/source/blender/compositor/intern/COM_NodeGraph.cpp +++ b/source/blender/compositor/intern/COM_NodeGraph.cpp @@ -188,7 +188,7 @@ NodeOutput *NodeGraph::find_output(const NodeRange &node_range, bNodeSocket *b_s void NodeGraph::add_bNodeLink(const NodeRange &node_range, bNodeLink *b_nodelink) { - /// \note: ignore invalid links + /// \note Ignore invalid links. if (!(b_nodelink->flag & NODE_LINK_VALID)) { return; } diff --git a/source/blender/compositor/intern/COM_NodeGraph.h b/source/blender/compositor/intern/COM_NodeGraph.h index 087b3dda48d..b005149c839 100644 --- a/source/blender/compositor/intern/COM_NodeGraph.h +++ b/source/blender/compositor/intern/COM_NodeGraph.h @@ -36,8 +36,9 @@ class Node; class NodeInput; class NodeOutput; -/** Internal representation of DNA node data. - * This structure is converted into operations by \a NodeCompiler. +/** + * Internal representation of DNA node data. + * This structure is converted into operations by \a NodeCompiler. */ class NodeGraph { public: diff --git a/source/blender/draw/engines/eevee/shaders/lit_surface_frag.glsl b/source/blender/draw/engines/eevee/shaders/lit_surface_frag.glsl index 3774054659d..978ce149be4 100644 --- a/source/blender/draw/engines/eevee/shaders/lit_surface_frag.glsl +++ b/source/blender/draw/engines/eevee/shaders/lit_surface_frag.glsl @@ -28,7 +28,8 @@ uniform int hairThicknessRes = 1; #endif /* LIT_SURFACE_UNIFORM */ -/** AUTO CONFIG +/** + * AUTO CONFIG * We include the file multiple times each time with a different configuration. * This leads to a lot of deadcode. Better idea would be to only generate the one needed. */ diff --git a/source/blender/editors/armature/armature_add.c b/source/blender/editors/armature/armature_add.c index 1073034383d..8a53883492e 100644 --- a/source/blender/editors/armature/armature_add.c +++ b/source/blender/editors/armature/armature_add.c @@ -116,7 +116,8 @@ EditBone *ED_armature_ebone_add_primitive(Object *obedit_arm, float length, bool /* previously addvert_armature */ /* the ctrl-click method */ -/** Note this is already ported to multi-objects as it is. +/** + * Note this is already ported to multi-objects as it is. * Since only the active bone is extruded even for single objects, * it makes sense to stick to the active object here. * diff --git a/source/blender/editors/curve/editcurve.c b/source/blender/editors/curve/editcurve.c index 994d844287c..af2d92533c3 100644 --- a/source/blender/editors/curve/editcurve.c +++ b/source/blender/editors/curve/editcurve.c @@ -3341,7 +3341,8 @@ void CURVE_OT_reveal(wmOperatorType *ot) /********************** subdivide operator *********************/ -/** Divide the line segments associated with the currently selected +/** + * Divide the line segments associated with the currently selected * curve nodes (Bezier or NURB). If there are no valid segment * selections within the current selection, nothing happens. */ diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c index 4a354dabd30..11106dd403f 100644 --- a/source/blender/editors/interface/interface_handlers.c +++ b/source/blender/editors/interface/interface_handlers.c @@ -2695,7 +2695,7 @@ void ui_but_clipboard_free(void) * It converts every UTF-8 character to an asterisk, and also remaps * the cursor position and selection start/end. * - * \note: remapping is used, because password could contain UTF-8 characters. + * \note remapping is used, because password could contain UTF-8 characters. * * \{ */ @@ -6976,8 +6976,10 @@ static bool ui_numedit_but_CURVEPROFILE(uiBlock *block, return changed; } -/** Interaction for curve profile widget. - * \note Uses hardcoded keys rather than the keymap. */ +/** + * Interaction for curve profile widget. + * \note Uses hardcoded keys rather than the keymap. + */ static int ui_do_but_CURVEPROFILE( bContext *C, uiBlock *block, uiBut *but, uiHandleButtonData *data, const wmEvent *event) { diff --git a/source/blender/editors/interface/interface_ops.c b/source/blender/editors/interface/interface_ops.c index 7ce4242c697..8af82864b03 100644 --- a/source/blender/editors/interface/interface_ops.c +++ b/source/blender/editors/interface/interface_ops.c @@ -852,10 +852,10 @@ bool UI_context_copy_to_selected_list(bContext *C, } /** - * called from both exec & poll + * Called from both exec & poll. * - * \note: normally we wouldn't call a loop from within a poll function, - * However this is a special case, and for regular poll calls, getting + * \note Normally we wouldn't call a loop from within a poll function, + * however this is a special case, and for regular poll calls, getting * the context from the button will fail early. */ static bool copy_to_selected_button(bContext *C, bool all, bool poll) @@ -1323,8 +1323,9 @@ static void UI_OT_editsource(wmOperatorType *ot) /** * EditTranslation utility funcs and operator, - * \note: this includes utility functions and button matching checks. - * this only works in conjunction with a py operator! + * + * \note this includes utility functions and button matching checks. + * this only works in conjunction with a Python operator! */ static void edittranslation_find_po_file(const char *root, const char *uilng, diff --git a/source/blender/editors/interface/interface_templates.c b/source/blender/editors/interface/interface_templates.c index b205572ba06..f5c5ef5f5e2 100644 --- a/source/blender/editors/interface/interface_templates.c +++ b/source/blender/editors/interface/interface_templates.c @@ -5068,8 +5068,10 @@ static void CurveProfile_buttons_layout(uiLayout *layout, PointerRNA *ptr, RNAUp UI_block_funcN_set(block, NULL, NULL, NULL); } -/** Template for a path creation widget intended for custom bevel profiles. - * This section is quite similar to uiTemplateCurveMapping, but with reduced complexity */ +/** + * Template for a path creation widget intended for custom bevel profiles. + * This section is quite similar to #uiTemplateCurveMapping, but with reduced complexity. + */ void uiTemplateCurveProfile(uiLayout *layout, PointerRNA *ptr, const char *propname) { RNAUpdateCb *cb; diff --git a/source/blender/editors/interface/interface_widgets.c b/source/blender/editors/interface/interface_widgets.c index 7f7352517c8..f9e4248fde3 100644 --- a/source/blender/editors/interface/interface_widgets.c +++ b/source/blender/editors/interface/interface_widgets.c @@ -249,8 +249,9 @@ typedef struct uiWidgetBase { uiWidgetBaseParameters uniform_params; } uiWidgetBase; -/** uiWidgetType: for time being only for visual appearance, - * later, a handling callback can be added too +/** + * For time being only for visual appearance, + * later, a handling callback can be added too. */ typedef struct uiWidgetType { diff --git a/source/blender/editors/interface/resources.c b/source/blender/editors/interface/resources.c index a405069efd8..a4dd0cb5c9f 100644 --- a/source/blender/editors/interface/resources.c +++ b/source/blender/editors/interface/resources.c @@ -971,9 +971,10 @@ const uchar *UI_ThemeGetColorPtr(bTheme *btheme, int spacetype, int colorid) } /** - * initialize default theme - * \note: when you add new colors, created & saved themes need initialized - * use function below, init_userdef_do_versions() + * Initialize default theme. + * + * \note When you add new colors, created & saved themes need initialized + * use function below, #init_userdef_do_versions. */ void UI_theme_init_default(void) { diff --git a/source/blender/editors/mesh/meshtools.c b/source/blender/editors/mesh/meshtools.c index a918996563f..772e7446430 100644 --- a/source/blender/editors/mesh/meshtools.c +++ b/source/blender/editors/mesh/meshtools.c @@ -793,10 +793,12 @@ int join_mesh_shapes_exec(bContext *C, wmOperator *op) static MirrTopoStore_t mesh_topo_store = {NULL, -1. - 1, -1}; -/** mode is 's' start, or 'e' end, or 'u' use +/** + * Mode is 's' start, or 'e' end, or 'u' use * if end, ob can be NULL. - * \note, is supposed return -1 on error, - * which callers are currently checking for, but is not used so far. */ + * \note This is supposed return -1 on error, + * which callers are currently checking for, but is not used so far. + */ int ED_mesh_mirror_topo_table(Object *ob, Mesh *me_eval, char mode) { if (mode == 'u') { /* use table */ diff --git a/source/blender/editors/object/object_transform.c b/source/blender/editors/object/object_transform.c index b534e1b9683..826d1db2538 100644 --- a/source/blender/editors/object/object_transform.c +++ b/source/blender/editors/object/object_transform.c @@ -1550,8 +1550,10 @@ void OBJECT_OT_origin_set(wmOperatorType *ot) #define USE_RELATIVE_ROTATION /** Disable overlays, ignoring user setting (light wire gets in the way). */ #define USE_RENDER_OVERRIDE -/** Calculate a depth if the cursor isn't already over a depth - * (not essential but feels buggy without). */ +/** + * Calculate a depth if the cursor isn't already over a depth + * (not essential but feels buggy without). + */ #define USE_FAKE_DEPTH_INIT struct XFormAxisItem { diff --git a/source/blender/editors/sculpt_paint/paint_image_proj.c b/source/blender/editors/sculpt_paint/paint_image_proj.c index 4c7e5e18257..fa4e250871e 100644 --- a/source/blender/editors/sculpt_paint/paint_image_proj.c +++ b/source/blender/editors/sculpt_paint/paint_image_proj.c @@ -190,9 +190,11 @@ BLI_INLINE unsigned char f_to_char(const float val) /* to avoid locking in tile initialization */ #define TILE_PENDING POINTER_FROM_INT(-1) -/** This is mainly a convenience struct used so we can keep an array of images we use - +/** + * This is mainly a convenience struct used so we can keep an array of images we use - * their imbufs, etc, in 1 array, When using threads this array is copied for each thread - * because 'partRedrawRect' and 'touch' values would not be thread safe */ + * because 'partRedrawRect' and 'touch' values would not be thread safe. + */ typedef struct ProjPaintImage { Image *ima; ImBuf *ibuf; diff --git a/source/blender/editors/space_file/fsmenu.h b/source/blender/editors/space_file/fsmenu.h index d9850cb855d..a86a552f9f9 100644 --- a/source/blender/editors/space_file/fsmenu.h +++ b/source/blender/editors/space_file/fsmenu.h @@ -33,7 +33,8 @@ enum FSMenuInsert; struct FSMenu; struct FSMenuEntry; -/** Inserts a new fsmenu entry with the given \a path. +/** + * Inserts a new fsmenu entry with the given \a path. * Duplicate entries are not added. * \param flag: Options for inserting the entry. */ diff --git a/source/blender/editors/space_outliner/outliner_draw.c b/source/blender/editors/space_outliner/outliner_draw.c index d7a7d57b100..11f18357f7b 100644 --- a/source/blender/editors/space_outliner/outliner_draw.c +++ b/source/blender/editors/space_outliner/outliner_draw.c @@ -415,7 +415,8 @@ static void outliner_collection_set_flag_recursive(Scene *scene, } } -/** Check if collection is already isolated. +/** + * Check if collection is already isolated. * * A collection is isolated if all its parents and children are "visible". * All the other collections must be "invisible". diff --git a/source/blender/editors/space_outliner/outliner_tools.c b/source/blender/editors/space_outliner/outliner_tools.c index 4664d3c08ff..476010a693d 100644 --- a/source/blender/editors/space_outliner/outliner_tools.c +++ b/source/blender/editors/space_outliner/outliner_tools.c @@ -546,7 +546,8 @@ static void merged_element_search_call_cb(struct bContext *C, void *UNUSED(arg1) } } -/** Merged element search menu +/** + * Merged element search menu * Created on activation of a merged or aggregated icon-row icon. */ static uiBlock *merged_element_search_menu(bContext *C, ARegion *ar, void *data) diff --git a/source/blender/editors/space_view3d/view3d_select.c b/source/blender/editors/space_view3d/view3d_select.c index 3eee76277e8..092142a83cd 100644 --- a/source/blender/editors/space_view3d/view3d_select.c +++ b/source/blender/editors/space_view3d/view3d_select.c @@ -3925,8 +3925,9 @@ static bool mball_circle_select(ViewContext *vc, return data.is_changed; } -/** Callbacks for circle selection in Editmode */ - +/** + * Callbacks for circle selection in Editmode + */ static bool obedit_circle_select(bContext *C, ViewContext *vc, wmGenericUserData *wm_userdata, diff --git a/source/blender/editors/space_view3d/view3d_snap.c b/source/blender/editors/space_view3d/view3d_snap.c index 9a2f4062631..35a116dc4b3 100644 --- a/source/blender/editors/space_view3d/view3d_snap.c +++ b/source/blender/editors/space_view3d/view3d_snap.c @@ -231,7 +231,8 @@ void VIEW3D_OT_snap_selected_to_grid(wmOperatorType *ot) /* *************************************************** */ -/** Snaps the selection as a whole (use_offset=true) or each selected object to the given location. +/** + * Snaps the selection as a whole (use_offset=true) or each selected object to the given location. * * \param snap_target_global: a location in global space to snap to * (eg. 3D cursor or active object). @@ -762,10 +763,11 @@ void VIEW3D_OT_snap_cursor_to_selected(wmOperatorType *ot) /* ********************************************** */ -/** Calculates the center position of the active object in global space. +/** + * Calculates the center position of the active object in global space. * * Note: this could be exported to be a generic function. - * see: calculateCenterActive + * see: #calculateCenterActive */ static bool snap_calc_active_center(bContext *C, const bool select_only, float r_center[3]) { diff --git a/source/blender/editors/space_view3d/view3d_view.c b/source/blender/editors/space_view3d/view3d_view.c index c64ace77a79..d7f7e96ba08 100644 --- a/source/blender/editors/space_view3d/view3d_view.c +++ b/source/blender/editors/space_view3d/view3d_view.c @@ -963,8 +963,10 @@ static bool drw_select_filter_object_mode_lock(Object *ob, void *user_data) return BKE_object_is_mode_compat(ob, obact->mode); } -/** Implement #VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK for special case when - * we want to select pose bones (this doesn't switch modes). */ +/** + * Implement #VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK for special case when + * we want to select pose bones (this doesn't switch modes). + */ static bool drw_select_filter_object_mode_lock_for_weight_paint(Object *ob, void *user_data) { LinkNode *ob_pose_list = user_data; diff --git a/source/blender/editors/transform/transform.h b/source/blender/editors/transform/transform.h index e5e7be025e4..4b529765ab0 100644 --- a/source/blender/editors/transform/transform.h +++ b/source/blender/editors/transform/transform.h @@ -213,8 +213,10 @@ typedef struct TransData2D { float ih1[2], ih2[2]; } TransData2D; -/** Used to store 2 handles for each #TransData in case the other handle wasn't selected. Also to - * unset temporary flags. */ +/** + * Used to store 2 handles for each #TransData in case the other handle wasn't selected. + * Also to unset temporary flags. + */ typedef struct TransDataCurveHandleFlags { char ih1, ih2; char *h1, *h2; diff --git a/source/blender/editors/transform/transform_convert_mesh.c b/source/blender/editors/transform/transform_convert_mesh.c index b9d69cafd0c..8b7dcecf9e8 100644 --- a/source/blender/editors/transform/transform_convert_mesh.c +++ b/source/blender/editors/transform/transform_convert_mesh.c @@ -192,8 +192,8 @@ static void editmesh_set_connectivity_distance(BMesh *bm, if (e_iter->l) { BMLoop *l_iter_radial, *l_first_radial; /** - * imaginary edge diagonally across quad, - * \note, this takes advantage of the rules of winding that we + * imaginary edge diagonally across quad. + * \note This takes advantage of the rules of winding that we * know 2 or more of a verts edges wont reference the same face twice. * Also, if the edge is hidden, the face will be hidden too. */ diff --git a/source/blender/editors/transform/transform_snap_object.c b/source/blender/editors/transform/transform_snap_object.c index 14e8b8f97e0..41486a2f767 100644 --- a/source/blender/editors/transform/transform_snap_object.c +++ b/source/blender/editors/transform/transform_snap_object.c @@ -65,7 +65,7 @@ #include "transform.h" /* -------------------------------------------------------------------- */ -/** Internal Data Types +/** \name Internal Data Types * \{ */ #define MAX_CLIPPLANE_LEN 3 @@ -147,7 +147,7 @@ struct SnapObjectContext { /** \} */ /* -------------------------------------------------------------------- */ -/** Common Utilities +/** \name Common Utilities * \{ */ /** @@ -1003,7 +1003,7 @@ static bool raycastObjects(SnapObjectContext *sctx, /** \} */ /* -------------------------------------------------------------------- */ -/** Snap Nearest utilities +/** \name Snap Nearest utilities * \{ */ /* Test BoundBox */ @@ -1161,7 +1161,7 @@ static bool test_projected_edge_dist(const struct DistProjectedAABBPrecalc *prec /** \} */ /* -------------------------------------------------------------------- */ -/** Walk DFS +/** \name Walk DFS * \{ */ typedef void (*Nearest2DGetVertCoCallback)(const int index, const float **co, void *data); diff --git a/source/blender/editors/util/numinput.c b/source/blender/editors/util/numinput.c index 8abd8db53c1..aca695be245 100644 --- a/source/blender/editors/util/numinput.c +++ b/source/blender/editors/util/numinput.c @@ -45,7 +45,8 @@ /* Numeric input which isn't allowing full numeric editing. */ #define USE_FAKE_EDIT -/** #NumInput.flag +/** + * #NumInput.flag * (1 << 8) and below are reserved for public flags! */ enum { diff --git a/source/blender/gpu/GPU_shader.h b/source/blender/gpu/GPU_shader.h index f4a94c7759a..b169b84c5b8 100644 --- a/source/blender/gpu/GPU_shader.h +++ b/source/blender/gpu/GPU_shader.h @@ -372,7 +372,8 @@ typedef struct GPUShaderConfigData { /* gpu_shader.c */ extern const GPUShaderConfigData GPU_shader_cfg_data[GPU_SHADER_CFG_LEN]; -/** Keep these in sync with: +/** + * Keep these in sync with: * - `gpu_shader_image_interlace_frag.glsl` * - `gpu_shader_image_rect_interlace_frag.glsl` */ diff --git a/source/blender/gpu/shaders/material/gpu_shader_material_tex_image.glsl b/source/blender/gpu/shaders/material/gpu_shader_material_tex_image.glsl index c234e064d36..bc2bf998145 100644 --- a/source/blender/gpu/shaders/material/gpu_shader_material_tex_image.glsl +++ b/source/blender/gpu/shaders/material/gpu_shader_material_tex_image.glsl @@ -67,7 +67,7 @@ void node_tex_image_nearest(vec3 co, sampler2D ima, out vec4 color, out float al alpha = color.a; } -/* @arg f: signed distance to texel center. */ +/** \param f: Signed distance to texel center. */ void cubic_bspline_coefs(vec2 f, out vec2 w0, out vec2 w1, out vec2 w2, out vec2 w3) { vec2 f2 = f * f; diff --git a/source/blender/imbuf/IMB_metadata.h b/source/blender/imbuf/IMB_metadata.h index 64a8db6c526..fc08e17dd96 100644 --- a/source/blender/imbuf/IMB_metadata.h +++ b/source/blender/imbuf/IMB_metadata.h @@ -28,7 +28,8 @@ struct IDProperty; struct ImBuf; struct anim; -/** The metadata is a list of key/value pairs (both char *) that can me +/** + * The metadata is a list of key/value pairs (both char *) that can me * saved in the header of several image formats. * Apart from some common keys like * 'Software' and 'Description' (png standard) we'll use keys within the @@ -38,29 +39,32 @@ struct anim; * The keys & values are stored in ID properties, in the group "metadata". */ -/** Ensure that the metadata property is a valid IDProperty object. +/** + * Ensure that the metadata property is a valid #IDProperty object. * This is a no-op when *metadata != NULL. */ 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 +/** + * 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, * memory has to be 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 + * \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); -/** Set user data in the metadata. +/** + * 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 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 */ diff --git a/source/blender/imbuf/IMB_thumbs.h b/source/blender/imbuf/IMB_thumbs.h index 5c7a60bbdcf..00e9a810ef3 100644 --- a/source/blender/imbuf/IMB_thumbs.h +++ b/source/blender/imbuf/IMB_thumbs.h @@ -30,7 +30,8 @@ extern "C" { struct ImBuf; -/** Thumbnail creation and retrieval according to the 'Thumbnail Management Standard' +/** + * Thumbnail creation and retrieval according to the 'Thumbnail Management Standard' * supported by Gimp, Gnome (Nautilus), KDE etc. * Reference: http://jens.triq.net/thumbnail-spec/index.html */ diff --git a/source/blender/imbuf/intern/rectop.c b/source/blender/imbuf/intern/rectop.c index 7150e41841b..7915f04b74e 100644 --- a/source/blender/imbuf/intern/rectop.c +++ b/source/blender/imbuf/intern/rectop.c @@ -213,7 +213,9 @@ void IMB_blend_color_float(float dst[4], } } -/** Crop */ +/* -------------------------------------------------------------------- */ +/** \name Crop + * \{ */ static void rect_crop_4bytes(void **buf_p, const int size_src[2], const rcti *crop) { @@ -279,8 +281,9 @@ void IMB_rect_crop(ImBuf *ibuf, const rcti *crop) ibuf->y = size_dst[1]; } -/** Re-alloc buffers at a new size */ - +/** + * Re-alloc buffers at a new size. + */ static void rect_realloc_4bytes(void **buf_p, const uint size[2]) { if (*buf_p == NULL) { @@ -318,6 +321,8 @@ void IMB_rect_size_set(ImBuf *ibuf, const uint size[2]) ibuf->y = size[1]; } +/** \} */ + /* clipping */ void IMB_rectclip(ImBuf *dbuf, diff --git a/source/blender/imbuf/intern/thumbs.c b/source/blender/imbuf/intern/thumbs.c index 06b8019a24d..eb4b29e81c1 100644 --- a/source/blender/imbuf/intern/thumbs.c +++ b/source/blender/imbuf/intern/thumbs.c @@ -132,11 +132,17 @@ static bool get_thumb_dir(char *dir, ThumbSize size) #undef THUMBNAILS -/** ----- begin of adapted code from glib --- +/* --- Begin of adapted code from glib. --- */ + +/* -------------------------------------------------------------------- */ +/** \name Escape URI String + * * The following code is adapted from function g_escape_uri_string from the gnome glib * Source: http://svn.gnome.org/viewcvs/glib/trunk/glib/gconvert.c?view=markup * released under the Gnu General Public License. - */ + * + * \{ */ + typedef enum { UNSAFE_ALL = 0x1, /* Escape all unsafe characters */ UNSAFE_ALLOW_PLUS = 0x2, /* Allows '+' */ @@ -295,7 +301,9 @@ static void escape_uri_string(const char *string, *q = '\0'; } -/** ----- end of adapted code from glib --- */ +/** \} */ + +/* --- End of adapted code from glib. --- */ static bool thumbhash_from_path(const char *UNUSED(path), ThumbSource source, char *r_hash) { diff --git a/source/blender/makesdna/DNA_curveprofile_types.h b/source/blender/makesdna/DNA_curveprofile_types.h index dba05da910e..13e638437c4 100644 --- a/source/blender/makesdna/DNA_curveprofile_types.h +++ b/source/blender/makesdna/DNA_curveprofile_types.h @@ -33,7 +33,8 @@ /** Dynamic size of widget's high resolution table. Input should be profile->totpoint. */ #define PROF_N_TABLE(n_pts) min_ii(PROF_TABLE_MAX, (((n_pts - 1)) * PROF_RESOL) + 1) -/** Each control point that makes up the profile. +/** + * Each control point that makes up the profile. * \note The flags use the same enum as Bezier curves, but they aren't guaranteed * to have identical functionality, and all types aren't implemented. */ diff --git a/source/blender/makesdna/DNA_customdata_types.h b/source/blender/makesdna/DNA_customdata_types.h index 9799489982d..0a6423d569f 100644 --- a/source/blender/makesdna/DNA_customdata_types.h +++ b/source/blender/makesdna/DNA_customdata_types.h @@ -32,7 +32,7 @@ extern "C" { #include "DNA_defs.h" -/** descriptor and storage for a custom data layer */ +/** Descriptor and storage for a custom data layer. */ typedef struct CustomDataLayer { /** Type of data in layer. */ int type; @@ -63,9 +63,11 @@ typedef struct CustomDataExternal { char filename[1024]; } CustomDataExternal; -/** structure which stores custom element data associated with mesh elements +/** + * Structure which stores custom element data associated with mesh elements * (vertices, edges or faces). The custom data is organized into a series of - * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */ + * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). + */ typedef struct CustomData { /** CustomDataLayers, ordered by type. */ CustomDataLayer *layers; diff --git a/source/blender/makesdna/DNA_meshdata_types.h b/source/blender/makesdna/DNA_meshdata_types.h index f6a7a8a5f5b..ebaaf72b3ae 100644 --- a/source/blender/makesdna/DNA_meshdata_types.h +++ b/source/blender/makesdna/DNA_meshdata_types.h @@ -59,9 +59,10 @@ typedef struct MVert { char flag, bweight; } MVert; -/** Tessellation vertex color data. +/** + * Tessellation vertex color data. * at the moment alpha is abused for vertex painting and not used for transparency, - * note that red and blue are swapped + * note that red and blue are swapped. */ typedef struct MCol { unsigned char a, r, g, b; diff --git a/source/blender/makesdna/DNA_object_enums.h b/source/blender/makesdna/DNA_object_enums.h index 75fca117b06..3214de5b3c6 100644 --- a/source/blender/makesdna/DNA_object_enums.h +++ b/source/blender/makesdna/DNA_object_enums.h @@ -49,8 +49,10 @@ typedef enum eObjectMode { /** Any mode that uses Object.sculpt. */ #define OB_MODE_ALL_SCULPT (OB_MODE_SCULPT | OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT) -/** Any mode that has data or for Grease Pencil modes, we need to free when switching modes, - * see: #ED_object_mode_generic_exit */ +/** + * Any mode that has data or for Grease Pencil modes, we need to free when switching modes, + * see: #ED_object_mode_generic_exit + */ #define OB_MODE_ALL_MODE_DATA \ (OB_MODE_EDIT | OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT | OB_MODE_SCULPT | OB_MODE_POSE | \ OB_MODE_PAINT_GPENCIL | OB_MODE_EDIT_GPENCIL | OB_MODE_SCULPT_GPENCIL | \ diff --git a/source/blender/makesdna/DNA_object_force_types.h b/source/blender/makesdna/DNA_object_force_types.h index 34a1b6d3e0b..8afb74e0786 100644 --- a/source/blender/makesdna/DNA_object_force_types.h +++ b/source/blender/makesdna/DNA_object_force_types.h @@ -492,8 +492,10 @@ typedef struct SoftBody { #define PTCACHE_READ_INFO (1 << 10) /** don't use the filename of the blendfile the data is linked from (write a local cache) */ #define PTCACHE_IGNORE_LIBPATH (1 << 11) -/** high resolution cache is saved for smoke for backwards compatibility, - * so set this flag to know it's a "fake" cache */ +/** + * High resolution cache is saved for smoke for backwards compatibility, + * so set this flag to know it's a "fake" cache. + */ #define PTCACHE_FAKE_SMOKE (1 << 12) #define PTCACHE_IGNORE_CLEAR (1 << 13) diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h index e60b16453b2..0de43c1632f 100644 --- a/source/blender/makesdna/DNA_scene_types.h +++ b/source/blender/makesdna/DNA_scene_types.h @@ -400,7 +400,7 @@ typedef enum eStereo3dInterlaceType { typedef struct ImageFormatData { /** * R_IMF_IMTYPE_PNG, R_... - * \note, video types should only ever be set from this structure when used from RenderData. + * \note Video types should only ever be set from this structure when used from #RenderData. */ char imtype; /** diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h index 8e4c4cc6ed4..9e8bda2d12f 100644 --- a/source/blender/makesdna/DNA_space_types.h +++ b/source/blender/makesdna/DNA_space_types.h @@ -973,7 +973,8 @@ typedef struct FileDirEntry { int act_variant; } FileDirEntry; -/** Array of direntries. +/** + * Array of direntries. * * This struct is used in various, different contexts. * diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index 2332fe39de3..3e10e817946 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -38,8 +38,10 @@ struct ColorBand; #define MAX_STYLE_NAME 64 -/** default offered by Blender. - * #uiFont.uifont_id */ +/** + * Default offered by Blender. + * #uiFont.uifont_id + */ typedef enum eUIFont_ID { UIFONT_DEFAULT = 0, /* UIFONT_BITMAP = 1 */ /* UNUSED */ @@ -1024,9 +1026,11 @@ typedef enum eUserpref_UI_Flag { USER_HIDE_SYSTEM_BOOKMARKS = (1u << 31), } eUserpref_UI_Flag; -/** #UserDef.uiflag2 +/** + * #UserDef.uiflag2 * - * \note don't add new flags here, use 'uiflag' which has flags free. */ + * \note don't add new flags here, use 'uiflag' which has flags free. + */ typedef enum eUserpref_UI_Flag2 { USER_UIFLAG2_UNUSED_0 = (1 << 0), /* cleared */ USER_REGION_OVERLAP = (1 << 1), @@ -1052,8 +1056,10 @@ typedef enum eUserpref_APP_Flag { USER_APP_LOCK_UI_LAYOUT = (1 << 0), } eUserpref_APP_Flag; -/** Auto-Keying mode. - * #UserDef.autokey_mode */ +/** + * Auto-Keying mode. + * #UserDef.autokey_mode + */ typedef enum eAutokey_Mode { /* AUTOKEY_ON is a bitflag */ AUTOKEY_ON = 1, @@ -1064,15 +1070,18 @@ typedef enum eAutokey_Mode { AUTOKEY_MODE_EDITKEYS = 5, } eAutokey_Mode; -/** Zoom to frame mode. - * #UserDef.view_frame_type */ +/** + * Zoom to frame mode. + * #UserDef.view_frame_type + */ typedef enum eZoomFrame_Mode { ZOOM_FRAME_MODE_KEEP_RANGE = 0, ZOOM_FRAME_MODE_SECONDS = 1, ZOOM_FRAME_MODE_KEYFRAMES = 2, } eZoomFrame_Mode; -/** Auto-Keying flag +/** + * Auto-Keying flag * #UserDef.autokey_flag (not strictly used when autokeying only - * is also used when keyframing these days). * \note #eAutokey_Flag is used with a macro, search for lines like IS_AUTOKEY_FLAG(INSERTAVAIL). @@ -1121,16 +1130,20 @@ typedef enum eDupli_ID_Flags { USER_DUP_GPENCIL = (1 << 13), } eDupli_ID_Flags; -/** Max anti alias draw method - * #UserDef.gpu_viewport_antialias */ +/** + * Max anti alias draw method + * #UserDef.gpu_viewport_antialias + */ typedef enum eOpenGL_AntiAliasMethod { USER_AA_NONE = 0, USER_AA_FXAA = 1, USER_AA_TAA8 = 2, } eOpenGL_AntiAliasMethod; -/** Text draw options - * #UserDef.text_render */ +/** + * Text draw options + * #UserDef.text_render + */ typedef enum eText_Draw_Options { USER_TEXT_DISABLE_AA = (1 << 0), @@ -1139,8 +1152,10 @@ typedef enum eText_Draw_Options { USER_TEXT_HINTING_FULL = (1 << 3), } eText_Draw_Options; -/** Grease Pencil Settings. - * #UserDef.gp_settings */ +/** + * Grease Pencil Settings. + * #UserDef.gp_settings + */ typedef enum eGP_UserdefSettings { GP_PAINT_UNUSED_0 = (1 << 0), } eGP_UserdefSettings; @@ -1149,8 +1164,10 @@ enum { USER_GIZMO_DRAW = (1 << 0), }; -/** Color Picker Types. - * #UserDef.color_picker_type */ +/** + * Color Picker Types. + * #UserDef.color_picker_type + */ typedef enum eColorPicker_Types { USER_CP_CIRCLE_HSV = 0, USER_CP_SQUARE_SV = 1, @@ -1159,8 +1176,10 @@ typedef enum eColorPicker_Types { USER_CP_CIRCLE_HSL = 4, } eColorPicker_Types; -/** Timecode display styles - * #UserDef.timecode_style */ +/** + * Timecode display styles + * #UserDef.timecode_style + */ typedef enum eTimecodeStyles { /** * As little info as is necessary to show relevant info with '+' to denote the frames diff --git a/source/blender/makesdna/intern/makesdna.c b/source/blender/makesdna/intern/makesdna.c index d6f52e48ebe..f4bc79b786a 100644 --- a/source/blender/makesdna/intern/makesdna.c +++ b/source/blender/makesdna/intern/makesdna.c @@ -159,7 +159,8 @@ static short *types_size_native; static short *types_size_32; /** Contains sizes as they are calculated on 64 bit systems. */ static short *types_size_64; -/** At `sp = structs[a]` is the first address of a struct definition: +/** + * At `sp = structs[a]` is the first address of a struct definition: * - `sp[0]` is type number. * - `sp[1]` is the length of the element array (next). * - `sp[2]` sp[3] is [(type_index, name_index), ..] (number of pairs is defined by `sp[1]`), diff --git a/source/blender/makesrna/RNA_types.h b/source/blender/makesrna/RNA_types.h index 2a341249247..6a60f09919b 100644 --- a/source/blender/makesrna/RNA_types.h +++ b/source/blender/makesrna/RNA_types.h @@ -37,7 +37,8 @@ struct ReportList; struct StructRNA; struct bContext; -/** Pointer +/** + * Pointer * * RNA pointers are not a single C pointer but include the type, * and a pointer to the ID struct that owns the struct, since diff --git a/source/blender/makesrna/intern/rna_access_compare_override.c b/source/blender/makesrna/intern/rna_access_compare_override.c index c3a81f0c6e1..a22b261368c 100644 --- a/source/blender/makesrna/intern/rna_access_compare_override.c +++ b/source/blender/makesrna/intern/rna_access_compare_override.c @@ -227,7 +227,8 @@ bool RNA_struct_equals(Main *bmain, PointerRNA *ptr_a, PointerRNA *ptr_b, eRNACo /* Low-level functions, also used by non-override RNA API like copy or equality check. */ -/** Generic RNA property diff function. +/** + * Generic RNA property diff function. * * \note about \a prop and \a prop_a/prop_b parameters: * the former is expected to be an 'un-resolved' one, @@ -816,8 +817,10 @@ bool RNA_struct_override_matches(Main *bmain, return matching; } -/** Store needed second operands into \a storage data-block - * for differential override operations. */ +/** + * Store needed second operands into \a storage data-block + * for differential override operations. + */ bool RNA_struct_override_store(Main *bmain, PointerRNA *ptr_local, PointerRNA *ptr_reference, @@ -977,8 +980,10 @@ static void rna_property_override_apply_ex(Main *bmain, } } -/** Apply given \a override operations on \a ptr_dst, using \a ptr_src - * (and \a ptr_storage for differential ops) as source. */ +/** + * Apply given \a override operations on \a ptr_dst, using \a ptr_src + * (and \a ptr_storage for differential ops) as source. + */ void RNA_struct_override_apply(Main *bmain, PointerRNA *ptr_dst, PointerRNA *ptr_src, diff --git a/source/blender/modifiers/intern/MOD_weightvgproximity.c b/source/blender/modifiers/intern/MOD_weightvgproximity.c index 7e23289433f..553743272a2 100644 --- a/source/blender/modifiers/intern/MOD_weightvgproximity.c +++ b/source/blender/modifiers/intern/MOD_weightvgproximity.c @@ -79,8 +79,10 @@ typedef struct Vert2GeomData { float *dist[3]; } Vert2GeomData; -/** Data which is localized to each computed chunk - * (i.e. thread-safe, and with continuous subset of index range). */ +/** + * Data which is localized to each computed chunk + * (i.e. thread-safe, and with continuous subset of index range). + */ typedef struct Vert2GeomDataChunk { /* Read-only data */ float last_hit_co[3][3]; diff --git a/source/blender/python/bmesh/bmesh_py_types_meshdata.c b/source/blender/python/bmesh/bmesh_py_types_meshdata.c index 2e15c1d9ce0..0fd6d74c324 100644 --- a/source/blender/python/bmesh/bmesh_py_types_meshdata.c +++ b/source/blender/python/bmesh/bmesh_py_types_meshdata.c @@ -384,19 +384,21 @@ PyObject *BPy_BMLoopColor_CreatePyObject(struct MLoopCol *data) * This is python type wraps a deform vert as a python dictionary, * hiding the #MDeformWeight on access, since the mapping is very close, eg: * - * C: - * weight = defvert_find_weight(dv, group_nr); - * defvert_remove_group(dv, dw) + * \code{.c} + * weight = defvert_find_weight(dv, group_nr); + * defvert_remove_group(dv, dw) + * \endcode * - * Py: - * weight = dv[group_nr] - * del dv[group_nr] + * \code{.py} + * weight = dv[group_nr] + * del dv[group_nr] + * \endcode * - * \note: there is nothing BMesh specific here, + * \note There is nothing BMesh specific here, * its only that BMesh is the only part of blender that uses a hand written api like this. * This type could eventually be used to access lattice weights. * - * \note: Many of blender-api's dict-like-wrappers act like ordered dicts, + * \note Many of blender-api's dict-like-wrappers act like ordered dicts, * This is intentionally _not_ ordered, the weights can be in any order and it won't matter, * the order should not be used in the api in any meaningful way (as with a python dict) * only expose as mapping, not a sequence. diff --git a/source/blender/python/intern/bpy_rna.c b/source/blender/python/intern/bpy_rna.c index 4c14f8ca8d3..6fb2b2fd7ee 100644 --- a/source/blender/python/intern/bpy_rna.c +++ b/source/blender/python/intern/bpy_rna.c @@ -2596,7 +2596,8 @@ static PyObject *pyrna_prop_collection_subscript_slice(BPy_PropertyRNA *self, return list; } -/** TODO - dimensions +/** + * TODO - dimensions * \note Could also use pyrna_prop_array_to_py_index(self, count) in a loop, but it's much slower * since at the moment it reads (and even allocates) the entire array for each index. */ diff --git a/source/blender/windowmanager/WM_api.h b/source/blender/windowmanager/WM_api.h index c6ea5d6d167..f7537f5ea9c 100644 --- a/source/blender/windowmanager/WM_api.h +++ b/source/blender/windowmanager/WM_api.h @@ -675,8 +675,10 @@ enum { WM_JOB_PROGRESS = (1 << 2), }; -/** Identifying jobs by owner alone is unreliable, this isnt saved, - * order can change (keep 0 for 'any'). */ +/** + * Identifying jobs by owner alone is unreliable, this isnt saved, + * order can change (keep 0 for 'any'). + */ enum { WM_JOB_TYPE_ANY = 0, WM_JOB_TYPE_COMPOSITE, diff --git a/source/blender/windowmanager/gizmo/intern/wm_gizmo.c b/source/blender/windowmanager/gizmo/intern/wm_gizmo.c index dd568d7baf1..a8ca65a8a83 100644 --- a/source/blender/windowmanager/gizmo/intern/wm_gizmo.c +++ b/source/blender/windowmanager/gizmo/intern/wm_gizmo.c @@ -686,11 +686,13 @@ void WM_gizmo_properties_sanitize(PointerRNA *ptr, const bool no_context) RNA_STRUCT_END; } -/** set all props to their default, +/** + * Set all props to their default. + * * \param do_update: Only update un-initialized props. * - * \note, there's nothing specific to gizmos here. - * this could be made a general function. + * \note There's nothing specific to gizmos here. + * This could be made a general function. */ bool WM_gizmo_properties_default(PointerRNA *ptr, const bool do_update) { diff --git a/source/blender/windowmanager/intern/wm_operators.c b/source/blender/windowmanager/intern/wm_operators.c index 9c3c433d675..61f51de41a5 100644 --- a/source/blender/windowmanager/intern/wm_operators.c +++ b/source/blender/windowmanager/intern/wm_operators.c @@ -644,11 +644,13 @@ void WM_operator_properties_sanitize(PointerRNA *ptr, const bool no_context) RNA_STRUCT_END; } -/** set all props to their default, +/** + * Set all props to their default. + * * \param do_update: Only update un-initialized props. * - * \note, there's nothing specific to operators here. - * this could be made a general function. + * \note There's nothing specific to operators here. + * This could be made a general function. */ bool WM_operator_properties_default(PointerRNA *ptr, const bool do_update) { |