diff options
author | Campbell Barton <ideasman42@gmail.com> | 2022-01-06 11:00:35 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2022-01-06 11:25:24 +0300 |
commit | 6f389f1bb856df2a1d9d29bc542b5ad76748a84e (patch) | |
tree | b465e79710bd87896ab7a979cef6727795528e87 /source/blender/editors | |
parent | c12607baa3a45eeceaf084c1e8b537183b6cc07e (diff) |
Cleanup: move public doc-strings into headers
Some recent changes re-introduced public-style doc-strings
in the source file.
Diffstat (limited to 'source/blender/editors')
5 files changed, 14 insertions, 13 deletions
diff --git a/source/blender/editors/animation/keyframes_general.c b/source/blender/editors/animation/keyframes_general.c index 8aac1e9b779..5d82b3b9939 100644 --- a/source/blender/editors/animation/keyframes_general.c +++ b/source/blender/editors/animation/keyframes_general.c @@ -345,10 +345,6 @@ static bool find_fcurve_segment(FCurve *fcu, return in_segment; } -/* Return a list of FCurveSegment with a start index and a length. - * A segment is a continuous selection of keyframes. - * Keys that have BEZT_FLAG_IGNORE_TAG set are treated as unselected. - * The caller is responsible for freeing the memory. */ ListBase find_fcurve_segments(FCurve *fcu) { ListBase segments = {NULL, NULL}; diff --git a/source/blender/editors/animation/keyframes_keylist.cc b/source/blender/editors/animation/keyframes_keylist.cc index 8dae46766fa..e4641ead2d2 100644 --- a/source/blender/editors/animation/keyframes_keylist.cc +++ b/source/blender/editors/animation/keyframes_keylist.cc @@ -850,7 +850,6 @@ bool actkeyblock_is_valid(const ActKeyColumn *ac) return ac != nullptr && ac->next != nullptr && ac->totblock > 0; } -/* Checks if ActKeyBlock should exist... */ int actkeyblock_get_valid_hold(const ActKeyColumn *ac) { /* check that block is valid */ diff --git a/source/blender/editors/include/ED_keyframes_edit.h b/source/blender/editors/include/ED_keyframes_edit.h index c54fb93e495..d08abf8aab8 100644 --- a/source/blender/editors/include/ED_keyframes_edit.h +++ b/source/blender/editors/include/ED_keyframes_edit.h @@ -327,13 +327,13 @@ KeyframeEditFunc ANIM_editkeyframes_easing(short mode); /** * Get a callback to populate the selection settings map - * requires: ked->custom = char[] of length fcurve->totvert. + * requires: `ked->custom = char[]` of length `fcurve->totvert`. */ KeyframeEditFunc ANIM_editkeyframes_buildselmap(short mode); /** * Change the selection status of the keyframe based on the map entry for this vert - * requires: ked->custom = char[] of length fcurve->totvert. + * requires: `ked->custom = char[]` of length `fcurve->totvert`. */ short bezt_selmap_flush(KeyframeEditData *ked, struct BezTriple *bezt); @@ -384,6 +384,13 @@ typedef struct FCurveSegment { struct FCurveSegment *next, *prev; int start_index, length; } FCurveSegment; + +/** + * Return a list of #FCurveSegment with a start index and a length. + * A segment is a continuous selection of keyframes. + * Keys that have BEZT_FLAG_IGNORE_TAG set are treated as unselected. + * The caller is responsible for freeing the memory. + */ ListBase find_fcurve_segments(struct FCurve *fcu); void clean_fcurve(struct bAnimContext *ac, struct bAnimListElem *ale, diff --git a/source/blender/editors/sculpt_paint/sculpt.c b/source/blender/editors/sculpt_paint/sculpt.c index fd550790f2e..21bbc9fb543 100644 --- a/source/blender/editors/sculpt_paint/sculpt.c +++ b/source/blender/editors/sculpt_paint/sculpt.c @@ -2128,10 +2128,6 @@ bool SCULPT_pbvh_calc_area_normal(const Brush *brush, return data.any_vertex_sampled; } -/** - * This calculates flatten center and area normal together, - * amortizing the memory bandwidth and loop overhead to calculate both at the same time. - */ void SCULPT_calc_area_normal_and_center( Sculpt *sd, Object *ob, PBVHNode **nodes, int totnode, float r_area_no[3], float r_area_co[3]) { @@ -3963,8 +3959,7 @@ static const char *sculpt_tool_name(Sculpt *sd) return "Sculpting"; } -/** - * Operator for applying a stroke (various attributes including mouse path) +/* Operator for applying a stroke (various attributes including mouse path) * using the current brush. */ void SCULPT_cache_free(StrokeCache *cache) diff --git a/source/blender/editors/sculpt_paint/sculpt_intern.h b/source/blender/editors/sculpt_paint/sculpt_intern.h index 35ffb214185..f239d12b69e 100644 --- a/source/blender/editors/sculpt_paint/sculpt_intern.h +++ b/source/blender/editors/sculpt_paint/sculpt_intern.h @@ -300,6 +300,10 @@ void SCULPT_calc_brush_plane(struct Sculpt *sd, void SCULPT_calc_area_normal( Sculpt *sd, Object *ob, PBVHNode **nodes, int totnode, float r_area_no[3]); +/** + * This calculates flatten center and area normal together, + * amortizing the memory bandwidth and loop overhead to calculate both at the same time. + */ void SCULPT_calc_area_normal_and_center( Sculpt *sd, Object *ob, PBVHNode **nodes, int totnode, float r_area_no[3], float r_area_co[3]); void SCULPT_calc_area_center( |