[Bf-blender-cvs] [7872bcafa0f] master: Cleanup: Document output of `BKE_object_where_is_calc` and friends

[Sybren A. Stüvel]

Commit: 7872bcafa0ffdc642406ac87e5261f69bb0d7bfb
Author: Sybren A. Stüvel
Date:   Mon Nov 2 15:16:05 2020 +0100
Branches: master
https://developer.blender.org/rB7872bcafa0ffdc642406ac87e5261f69bb0d7bfb

Cleanup: Document output of `BKE_object_where_is_calc` and friends

Add a comment to the declaration of the `BKE_object_where_is_calc...()`
functions to explain where the result of the calculation is stored.

No functional changes.

===================================================================

M	source/blender/blenkernel/BKE_object.h

===================================================================

diff --git a/source/blender/blenkernel/BKE_object.h b/source/blender/blenkernel/BKE_object.h
index 0a992f2cb58..b7015942cb4 100644
--- a/source/blender/blenkernel/BKE_object.h
+++ b/source/blender/blenkernel/BKE_object.h
@@ -191,6 +191,8 @@ struct Base **BKE_object_pose_base_array_get(struct ViewLayer *view_layer,
                                              unsigned int *r_bases_len);
 
 void BKE_object_get_parent_matrix(struct Object *ob, struct Object *par, float r_parentmat[4][4]);
+
+/* Compute object world transform and store it in ob->obmat. */
 void BKE_object_where_is_calc(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
 void BKE_object_where_is_calc_ex(struct Depsgraph *depsgraph,
                                  struct Scene *scene,