Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2019-11-24 17:14:39 +0300
committerCampbell Barton <ideasman42@gmail.com>2019-11-24 17:51:11 +0300
commit249f4423ee1c28e7f8ad6fdfff6c61a1f3e6d53d (patch)
tree41f7476be0d4d2ac9856602d1094c542d74afeef /source/blender/blenkernel/intern
parentace5677ef0db996a4236073d1e1d6895fd5cf4bd (diff)
Cleanup: doxygen comments
Also correct some outdated symbol references, add missing 'name' commands.
Diffstat (limited to 'source/blender/blenkernel/intern')
-rw-r--r--source/blender/blenkernel/intern/action.c5
-rw-r--r--source/blender/blenkernel/intern/anim_sys.c6
-rw-r--r--source/blender/blenkernel/intern/armature.c6
-rw-r--r--source/blender/blenkernel/intern/colortools.c3
-rw-r--r--source/blender/blenkernel/intern/crazyspace.c6
-rw-r--r--source/blender/blenkernel/intern/curveprofile.c161
-rw-r--r--source/blender/blenkernel/intern/font.c6
-rw-r--r--source/blender/blenkernel/intern/gpencil.c3
-rw-r--r--source/blender/blenkernel/intern/icons.c6
-rw-r--r--source/blender/blenkernel/intern/key.c3
-rw-r--r--source/blender/blenkernel/intern/library.c21
-rw-r--r--source/blender/blenkernel/intern/library_override.c3
-rw-r--r--source/blender/blenkernel/intern/library_remap.c3
-rw-r--r--source/blender/blenkernel/intern/mball.c3
-rw-r--r--source/blender/blenkernel/intern/mesh_evaluate.c3
-rw-r--r--source/blender/blenkernel/intern/object.c3
-rw-r--r--source/blender/blenkernel/intern/scene.c3
-rw-r--r--source/blender/blenkernel/intern/screen.c2
-rw-r--r--source/blender/blenkernel/intern/studiolight.c4
-rw-r--r--source/blender/blenkernel/intern/undo_system.c6
20 files changed, 173 insertions, 83 deletions
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. */