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 <campbell@blender.org>2022-06-30 16:00:55 +0300
committerCampbell Barton <campbell@blender.org>2022-06-30 16:48:22 +0300
commit8bf9d482dacf54c72291de187676ff76845e807f (patch)
treeda48f3fe8ad2be99c606cc5cb15a1001ac95c0df /source/blender/blenkernel/BKE_constraint.h
parent58ccd8338e53423e223085094af2d35c76285c30 (diff)
Cleanup: colon after params, move text into public doc-strings, spelling
Diffstat (limited to 'source/blender/blenkernel/BKE_constraint.h')
-rw-r--r--source/blender/blenkernel/BKE_constraint.h16
1 files changed, 9 insertions, 7 deletions
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);