EPhysics: add note regarding body data
authorBruno Dilly <bdilly@profusion.mobi>
Fri, 27 Jul 2012 14:48:41 +0000 (14:48 +0000)
committerBruno Dilly <bdilly@profusion.mobi>
Fri, 27 Jul 2012 14:48:41 +0000 (14:48 +0000)
Requested by Ricardo.

SVN revision: 74497

legacy/ephysics/src/lib/EPhysics.h

index 35b36d5..9ff2f23 100644 (file)
@@ -1680,6 +1680,11 @@ EAPI double ephysics_body_rotation_get(const EPhysics_Body *body);
  * some values that must to be updated when a collision occurs between two
  * bodies.
  *
+ * @note EPhysics won't handle this data, it won't be used in any way
+ * by the library. If it need to be freed when the body is deleted, a
+ * callback for @ref EPHYSICS_CALLBACK_BODY_DEL can be added and
+ * data should be explicity freed.
+ *
  * @param body The physics body.
  * @param data The data to be set.
  *