Cleanup: colon after params, move text into public doc-strings, spelling
This commit is contained in:
parent
58ccd8338e
commit
8bf9d482da
|
@ -164,10 +164,11 @@ bool BKE_camera_multiview_spherical_stereo(const struct RenderData *rd,
|
|||
/* Camera background image API */
|
||||
|
||||
struct CameraBGImage *BKE_camera_background_image_new(struct Camera *cam);
|
||||
|
||||
/**
|
||||
* Duplicate a background image, in a ID management compatible way.
|
||||
*
|
||||
* \param copy_flag The usual ID copying flags, see `LIB_ID_CREATE_`/`LIB_ID_COPY_` enums in
|
||||
* \param copy_flag: The usual ID copying flags, see `LIB_ID_CREATE_`/`LIB_ID_COPY_` enums in
|
||||
* `BKE_lib_id.h`.
|
||||
*/
|
||||
struct CameraBGImage *BKE_camera_background_image_copy(struct CameraBGImage *bgpic_src,
|
||||
|
|
|
@ -265,6 +265,8 @@ void BKE_constraint_panel_expand(struct bConstraint *con);
|
|||
/* Constraint Evaluation function prototypes */
|
||||
|
||||
/**
|
||||
* Package an object/bone for use in constraint evaluation.
|
||||
*
|
||||
* This function MEM_calloc's a #bConstraintOb struct,
|
||||
* that will need to be freed after evaluation.
|
||||
*/
|
||||
|
@ -312,17 +314,17 @@ void BKE_constraint_target_matrix_get(struct Depsgraph *depsgraph,
|
|||
* Retrieves the list of all constraint targets, including the custom space target.
|
||||
* Must be followed by a call to BKE_constraint_targets_flush to free memory.
|
||||
*
|
||||
* \param r_targets Pointer to the list to be initialized with target data.
|
||||
* \param r_targets: Pointer to the list to be initialized with target data.
|
||||
* \returns the number of targets stored in the list.
|
||||
*/
|
||||
int BKE_constraint_targets_get(struct bConstraint *con, struct ListBase *r_targets);
|
||||
|
||||
/**
|
||||
* Copies changed data from the list produced by BKE_constraint_targets_get back to the constraint
|
||||
* Copies changed data from the list produced by #BKE_constraint_targets_get back to the constraint
|
||||
* data structures and frees memory.
|
||||
*
|
||||
* \param targets List of targets filled by BKE_constraint_targets_get.
|
||||
* \param no_copy Only free memory without copying changes (read-only mode).
|
||||
* \param targets: List of targets filled by BKE_constraint_targets_get.
|
||||
* \param no_copy: Only free memory without copying changes (read-only mode).
|
||||
*/
|
||||
void BKE_constraint_targets_flush(struct bConstraint *con, struct ListBase *targets, bool no_copy);
|
||||
|
||||
|
@ -336,10 +338,10 @@ void BKE_constraint_targets_for_solving_get(struct Depsgraph *depsgraph,
|
|||
float ctime);
|
||||
|
||||
/**
|
||||
* Initializes the custom coordinate space data if required by the constraint.
|
||||
* Initialize the Custom Space matrix inside `cob` (if required by the constraint).
|
||||
*
|
||||
* \param cob Constraint evaluation context (contains the matrix to be initialized).
|
||||
* \param con Constraint that is about to be evaluated.
|
||||
* \param cob: Constraint evaluation context (contains the matrix to be initialized).
|
||||
* \param con: Constraint that is about to be evaluated.
|
||||
*/
|
||||
void BKE_constraint_custom_object_space_init(struct bConstraintOb *cob, struct bConstraint *con);
|
||||
|
||||
|
|
|
@ -323,8 +323,9 @@ struct FCurve *BKE_fcurve_find_by_rna(struct PointerRNA *ptr,
|
|||
* Same as above, but takes a context data,
|
||||
* temp hack needed for complex paths like texture ones.
|
||||
*
|
||||
* \param r_special Optional, ignored when NULL. Set to `true` if the given RNA `ptr` is a NLA
|
||||
* strip, and the returned F-curve comes from this NLA strip. */
|
||||
* \param r_special: Optional, ignored when NULL. Set to `true` if the given RNA `ptr` is a NLA
|
||||
* strip, and the returned F-curve comes from this NLA strip.
|
||||
*/
|
||||
struct FCurve *BKE_fcurve_find_by_rna_context_ui(struct bContext *C,
|
||||
const struct PointerRNA *ptr,
|
||||
struct PropertyRNA *prop,
|
||||
|
|
|
@ -73,9 +73,9 @@ bool BKE_lib_override_library_is_system_defined(const struct Main *bmain, const
|
|||
* Check if given Override Property for given ID is animated (through a F-Curve in an Action, or
|
||||
* from a driver).
|
||||
*
|
||||
* \param override_rna_prop if not NULL, the RNA property matching the given path in the
|
||||
* \param override_rna_prop: if not NULL, the RNA property matching the given path in the
|
||||
* `override_prop`.
|
||||
* \param rnaprop_index Array in the RNA property, 0 if unknown or irrelevant.
|
||||
* \param rnaprop_index: Array in the RNA property, 0 if unknown or irrelevant.
|
||||
*/
|
||||
bool BKE_lib_override_library_property_is_animated(const ID *id,
|
||||
const IDOverrideLibraryProperty *override_prop,
|
||||
|
|
|
@ -116,7 +116,6 @@ void BKE_constraint_unique_name(bConstraint *con, ListBase *list)
|
|||
|
||||
/* ----------------- Evaluation Loop Preparation --------------- */
|
||||
|
||||
/* package an object/bone for use in constraint evaluation */
|
||||
bConstraintOb *BKE_constraints_make_evalob(
|
||||
Depsgraph *depsgraph, Scene *scene, Object *ob, void *subdata, short datatype)
|
||||
{
|
||||
|
@ -6323,7 +6322,6 @@ void BKE_constraint_targets_for_solving_get(struct Depsgraph *depsgraph,
|
|||
}
|
||||
}
|
||||
|
||||
/** Initialize the Custom Space matrix inside cob. */
|
||||
void BKE_constraint_custom_object_space_init(bConstraintOb *cob, bConstraint *con)
|
||||
{
|
||||
if (con && con->space_object && is_custom_space_needed(con)) {
|
||||
|
|
|
@ -740,7 +740,7 @@ static void select_grow_invoke_per_curve(Curves &curves_id,
|
|||
|
||||
threading::parallel_invoke(
|
||||
[&]() {
|
||||
/* Build kd-tree for the selected points. */
|
||||
/* Build KD-tree for the selected points. */
|
||||
KDTree_3d *kdtree = BLI_kdtree_3d_new(curve_op_data.selected_point_indices.size());
|
||||
BLI_SCOPED_DEFER([&]() { BLI_kdtree_3d_free(kdtree); });
|
||||
for (const int point_i : curve_op_data.selected_point_indices) {
|
||||
|
@ -765,7 +765,7 @@ static void select_grow_invoke_per_curve(Curves &curves_id,
|
|||
});
|
||||
},
|
||||
[&]() {
|
||||
/* Build kd-tree for the unselected points. */
|
||||
/* Build KD-tree for the unselected points. */
|
||||
KDTree_3d *kdtree = BLI_kdtree_3d_new(curve_op_data.unselected_point_indices.size());
|
||||
BLI_SCOPED_DEFER([&]() { BLI_kdtree_3d_free(kdtree); });
|
||||
for (const int point_i : curve_op_data.unselected_point_indices) {
|
||||
|
@ -1011,7 +1011,7 @@ static int calculate_points_per_side(bContext *C, MinDistanceEditData &op_data)
|
|||
}
|
||||
}
|
||||
|
||||
/* Limit to a harcoded number since it only adds noise at some point. */
|
||||
/* Limit to a hard-coded number since it only adds noise at some point. */
|
||||
return std::min(300, needed_points);
|
||||
}
|
||||
|
||||
|
|
|
@ -30,10 +30,10 @@
|
|||
|
||||
/**
|
||||
* The code below uses a prefix naming convention to indicate the coordinate space:
|
||||
* cu: Local space of the curves object that is being edited.
|
||||
* su: Local space of the surface object.
|
||||
* wo: World space.
|
||||
* re: 2D coordinates within the region.
|
||||
* `cu`: Local space of the curves object that is being edited.
|
||||
* `su`: Local space of the surface object.
|
||||
* `wo`: World space.
|
||||
* `re`: 2D coordinates within the region.
|
||||
*/
|
||||
|
||||
namespace blender::ed::sculpt_paint {
|
||||
|
|
|
@ -1182,9 +1182,9 @@ GPU_PBVH_Buffers *GPU_pbvh_bmesh_buffers_build(bool smooth_shading)
|
|||
* Builds a list of attributes from a set of domains and a set of
|
||||
* customdata types.
|
||||
*
|
||||
* \param active_only Returns only one item, a GPUAttrRef to active_layer
|
||||
* \param active_layer CustomDataLayer to use for the active layer
|
||||
* \param active_layer CustomDataLayer to use for the render layer
|
||||
* \param active_only: Returns only one item, a #GPUAttrRef to active_layer.
|
||||
* \param active_layer: #CustomDataLayer to use for the active layer.
|
||||
* \param active_layer: #CustomDataLayer to use for the render layer.
|
||||
*/
|
||||
static int gpu_pbvh_make_attr_offs(eAttrDomainMask domain_mask,
|
||||
eCustomDataMask type_mask,
|
||||
|
|
|
@ -497,7 +497,7 @@ char *RNA_path_back(const char *path);
|
|||
* character in `rna_path` that is part of the array index for the given property. Return NULL if
|
||||
* none can be found, e.g. because the property is not an RNA array.
|
||||
*
|
||||
* \param array_prop if not NULL, the PropertyRNA assumed to be the last one from the RNA path.
|
||||
* \param array_prop: if not NULL, the #PropertyRNA assumed to be the last one from the RNA path.
|
||||
* Only used to ensure it is a valid array property.
|
||||
*/
|
||||
const char *RNA_path_array_index_token_find(const char *rna_path, const PropertyRNA *array_prop);
|
||||
|
|
Loading…
Reference in New Issue