diff options
| -rw-r--r-- | source/blender/blenkernel/BKE_camera.h | 3 | ||||
| -rw-r--r-- | source/blender/blenkernel/BKE_constraint.h | 16 | ||||
| -rw-r--r-- | source/blender/blenkernel/BKE_fcurve.h | 5 | ||||
| -rw-r--r-- | source/blender/blenkernel/BKE_lib_override.h | 4 | ||||
| -rw-r--r-- | source/blender/blenkernel/intern/constraint.c | 2 | ||||
| -rw-r--r-- | source/blender/editors/sculpt_paint/curves_sculpt_ops.cc | 6 | ||||
| -rw-r--r-- | source/blender/editors/sculpt_paint/curves_sculpt_pinch.cc | 8 | ||||
| -rw-r--r-- | source/blender/gpu/intern/gpu_buffers.c | 6 | ||||
| -rw-r--r-- | source/blender/makesrna/RNA_access.h | 2 |
9 files changed, 27 insertions, 25 deletions
diff --git a/source/blender/blenkernel/BKE_camera.h b/source/blender/blenkernel/BKE_camera.h index 40df7acd066..afe0eb35c4d 100644 --- a/source/blender/blenkernel/BKE_camera.h +++ b/source/blender/blenkernel/BKE_camera.h @@ -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, diff --git a/source/blender/blenkernel/BKE_constraint.h b/source/blender/blenkernel/BKE_constraint.h index 2be299f5b0c..3186be3674d 100644 --- a/source/blender/blenkernel/BKE_constraint.h +++ b/source/blender/blenkernel/BKE_constraint.h @@ -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); diff --git a/source/blender/blenkernel/BKE_fcurve.h b/source/blender/blenkernel/BKE_fcurve.h index 4489527fcab..10d9ce3364d 100644 --- a/source/blender/blenkernel/BKE_fcurve.h +++ b/source/blender/blenkernel/BKE_fcurve.h @@ -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, diff --git a/source/blender/blenkernel/BKE_lib_override.h b/source/blender/blenkernel/BKE_lib_override.h index 2e28b3c00ee..b2162e651fd 100644 --- a/source/blender/blenkernel/BKE_lib_override.h +++ b/source/blender/blenkernel/BKE_lib_override.h @@ -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, diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c index cee32dc557b..8400d610a32 100644 --- a/source/blender/blenkernel/intern/constraint.c +++ b/source/blender/blenkernel/intern/constraint.c @@ -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)) { diff --git a/source/blender/editors/sculpt_paint/curves_sculpt_ops.cc b/source/blender/editors/sculpt_paint/curves_sculpt_ops.cc index 739c39f6196..5c73c7a37d3 100644 --- a/source/blender/editors/sculpt_paint/curves_sculpt_ops.cc +++ b/source/blender/editors/sculpt_paint/curves_sculpt_ops.cc @@ -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); } diff --git a/source/blender/editors/sculpt_paint/curves_sculpt_pinch.cc b/source/blender/editors/sculpt_paint/curves_sculpt_pinch.cc index db890d6a054..5b7359a3905 100644 --- a/source/blender/editors/sculpt_paint/curves_sculpt_pinch.cc +++ b/source/blender/editors/sculpt_paint/curves_sculpt_pinch.cc @@ -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 { diff --git a/source/blender/gpu/intern/gpu_buffers.c b/source/blender/gpu/intern/gpu_buffers.c index 8665b49f4aa..14bbd82c282 100644 --- a/source/blender/gpu/intern/gpu_buffers.c +++ b/source/blender/gpu/intern/gpu_buffers.c @@ -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, diff --git a/source/blender/makesrna/RNA_access.h b/source/blender/makesrna/RNA_access.h index 67605201a9f..005228bea72 100644 --- a/source/blender/makesrna/RNA_access.h +++ b/source/blender/makesrna/RNA_access.h @@ -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); |