code cleanup: merge doxygen comments into C source.
authorCampbell Barton <ideasman42@gmail.com>
Sat, 26 Oct 2013 03:56:32 +0000 (03:56 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Sat, 26 Oct 2013 03:56:32 +0000 (03:56 +0000)
source/blender/blenkernel/BKE_action.h
source/blender/blenkernel/intern/action.c

index 698098d28c3492ee62fce4d6f3771dd8bfca3682..5c155a461821bed2918b0702554661e706d24926 100644 (file)
@@ -132,60 +132,19 @@ struct bActionGroup *BKE_action_group_find_name(struct bAction *act, const char
 void action_groups_clear_tempflags(struct bAction *act);
 
 /* Pose API ----------------- */       
-       
-/**
- * Deallocates a pose channel.
- * Does not free the pose channel itself.
- */
-void BKE_pose_channel_free(struct bPoseChannel *pchan);
-
-/**
- * Removes and deallocates all channels from a pose.
- * Does not free the pose itself.
- */
-void BKE_pose_channels_free(struct bPose *pose);
 
-/**
- * Removes the hash for quick lookup of channels, must
- * be done when adding/removing channels.
- */
-void BKE_pose_channels_hash_make(struct bPose *pose);
-void BKE_pose_channels_hash_free(struct bPose *pose);
-
-/** 
- * Removes and deallocates all data from a pose, and also frees the pose.
- */
-void BKE_pose_free(struct bPose *pose);
+void                 BKE_pose_channel_free(struct bPoseChannel *pchan);
 
-/**
- * Allocate a new pose on the heap, and copy the src pose and it's channels
- * into the new pose. *dst is set to the newly allocated structure, and assumed to be NULL.
- */ 
-void BKE_pose_copy_data(struct bPose **dst, struct bPose *src, int copyconstraints);
+void                 BKE_pose_channels_free(struct bPose *pose);
 
-/**
- * Copy the internal members of each pose channel including constraints
- * and ID-Props, used when duplicating bones in editmode.
- */
-void BKE_pose_channel_copy_data(struct bPoseChannel *pchan, const struct bPoseChannel *pchan_from);
+void                 BKE_pose_channels_hash_make(struct bPose *pose);
+void                 BKE_pose_channels_hash_free(struct bPose *pose);
 
-/**
- * Return a pointer to the pose channel of the given name
- * from this pose.
- */
+void                 BKE_pose_free(struct bPose *pose);
+void                 BKE_pose_copy_data(struct bPose **dst, struct bPose *src, const bool copy_constraints);
+void                 BKE_pose_channel_copy_data(struct bPoseChannel *pchan, const struct bPoseChannel *pchan_from);
 struct bPoseChannel *BKE_pose_channel_find_name(const struct bPose *pose, const char *name);
-
-/**
- * Return a pointer to the active pose channel from this Object.
- * (Note: Object, not bPose is used here, as we need layer info from Armature)
- */
 struct bPoseChannel *BKE_pose_channel_active(struct Object *ob);
-
-/** 
- * Looks to see if the channel with the given name
- * already exists in this pose - if not a new one is
- * allocated and initialized.
- */
 struct bPoseChannel *BKE_pose_channel_verify(struct bPose *pose, const char *name);
 
 #ifndef NDEBUG
index b0644da45987f3a0414b48f296ed074afc5c24ec..94da2a330c1e867a5131241121377c34b8013a45 100644 (file)
@@ -440,6 +440,10 @@ void action_groups_clear_tempflags(bAction *act)
 
 /* *************** Pose channels *************** */
 
+/**
+ * Return a pointer to the pose channel of the given name
+ * from this pose.
+ */
 bPoseChannel *BKE_pose_channel_find_name(const bPose *pose, const char *name)
 {
        if (ELEM(NULL, pose, name) || (name[0] == '\0'))
@@ -451,8 +455,14 @@ bPoseChannel *BKE_pose_channel_find_name(const bPose *pose, const char *name)
        return BLI_findstring(&((bPose *)pose)->chanbase, name, offsetof(bPoseChannel, name));
 }
 
-/* Use with care, not on Armature poses but for temporal ones */
-/* (currently used for action constraints and in rebuild_pose) */
+/**
+ * Looks to see if the channel with the given name
+ * already exists in this pose - if not a new one is
+ * allocated and initialized.
+ *
+ * \note Use with care, not on Armature poses but for temporal ones.
+ * \note (currently used for action constraints and in rebuild_pose).
+ */
 bPoseChannel *BKE_pose_channel_verify(bPose *pose, const char *name)
 {
        bPoseChannel *chan;
@@ -505,7 +515,12 @@ bool BKE_pose_channels_is_valid(const bPose *pose)
 }
 
 #endif
-/* Find the active posechannel for an object (we can't just use pose, as layer info is in armature) */
+
+/**
+ * Find the active posechannel for an object (we can't just use pose, as layer info is in armature)
+ *
+ * \note: Object, not bPose is used here, as we need layer info from Armature)
+ */
 bPoseChannel *BKE_pose_channel_active(Object *ob)
 {
        bArmature *arm = (ob) ? ob->data : NULL;
@@ -536,8 +551,14 @@ const char *BKE_pose_ikparam_get_name(bPose *pose)
        }
        return NULL;
 }
-/* dst should be freed already, makes entire duplicate */
-void BKE_pose_copy_data(bPose **dst, bPose *src, int copycon)
+
+/**
+ * Allocate a new pose on the heap, and copy the src pose and it's channels
+ * into the new pose. *dst is set to the newly allocated structure, and assumed to be NULL.
+ *
+ * \param dst  Should be freed already, makes entire duplicate.
+ */
+void BKE_pose_copy_data(bPose **dst, bPose *src, const bool copy_constraints)
 {
        bPose *outPose;
        bPoseChannel *pchan;
@@ -558,8 +579,7 @@ void BKE_pose_copy_data(bPose **dst, bPose *src, int copycon)
        outPose->avs = src->avs;
        
        for (pchan = outPose->chanbase.first; pchan; pchan = pchan->next) {
-               /* TODO: rename this argument... */
-               if (copycon) {
+               if (copy_constraints) {
                        BKE_copy_constraints(&listb, &pchan->constraints, TRUE);  // BKE_copy_constraints NULLs listb
                        pchan->constraints = listb;
                        pchan->mpath = NULL; /* motion paths should not get copied yet... */
@@ -571,8 +591,9 @@ void BKE_pose_copy_data(bPose **dst, bPose *src, int copycon)
        }
 
        /* for now, duplicate Bone Groups too when doing this */
-       if (copycon)
+       if (copy_constraints) {
                BLI_duplicatelist(&outPose->agroups, &src->agroups);
+       }
        
        *dst = outPose;
 }
@@ -641,7 +662,10 @@ bool BKE_pose_channel_in_IK_chain(Object *ob, bPoseChannel *pchan)
        return pose_channel_in_IK_chain(ob, pchan, 0);
 }
 
-
+/**
+ * Removes the hash for quick lookup of channels, must
+ * be done when adding/removing channels.
+ */
 void BKE_pose_channels_hash_make(bPose *pose) 
 {
        if (!pose->chanhash) {
@@ -661,6 +685,10 @@ void BKE_pose_channels_hash_free(bPose *pose)
        }
 }
 
+/**
+ * Deallocates a pose channel.
+ * Does not free the pose channel itself.
+ */
 void BKE_pose_channel_free(bPoseChannel *pchan)
 {
        if (pchan->custom) {
@@ -681,6 +709,10 @@ void BKE_pose_channel_free(bPoseChannel *pchan)
        }
 }
 
+/**
+ * Removes and deallocates all channels from a pose.
+ * Does not free the pose itself.
+ */
 void BKE_pose_channels_free(bPose *pose) 
 {
        bPoseChannel *pchan;
@@ -695,6 +727,9 @@ void BKE_pose_channels_free(bPose *pose)
        BKE_pose_channels_hash_free(pose);
 }
 
+/**
+ * Removes and deallocates all data from a pose, and also frees the pose.
+ */
 void BKE_pose_free(bPose *pose)
 {
        if (pose) {
@@ -739,9 +774,13 @@ static void copy_pose_channel_data(bPoseChannel *pchan, const bPoseChannel *chan
        }
 }
 
-/* makes copies of internal data, unlike copy_pose_channel_data which only
- * copies the pose state.
- * hint: use when copying bones in editmode (on returned value from BKE_pose_channel_verify) */
+/**
+ * Copy the internal members of each pose channel including constraints
+ * and ID-Props, used when duplicating bones in editmode.
+ * (unlike copy_pose_channel_data which only).
+ *
+ * \note use when copying bones in editmode (on returned value from #BKE_pose_channel_verify)
+ */
 void BKE_pose_channel_copy_data(bPoseChannel *pchan, const bPoseChannel *pchan_from)
 {
        /* copy transform locks */