code cleanup: move doxy docs from headers into source. also replace strncpy();str[len]=0 with BLI_strncpy() in BLI_stringdec().

1 files changed, 0 insertions, 84 deletions

diff --git a/source/blender/blenkernel/BKE_idprop.h b/source/blender/blenkernel/BKE_idprop.h
index ad3e4bb2251..d8ad3b2e892 100644
--- a/source/blender/blenkernel/BKE_idprop.h
+++ b/source/blender/blenkernel/BKE_idprop.h
@@ -58,8 +58,6 @@ typedef union IDPropertyTemplate {
 
 /* ----------- Property Array Type ---------- */
 
-/* note: as a start to move away from the stupid IDP_New function, this type
- * has it's own allocation function.*/
 IDProperty *IDP_NewIDPArray(const char *name)
 #ifdef __GNUC__
 __attribute__((warn_unused_result))
@@ -136,18 +134,11 @@ __attribute__((nonnull))
 #endif
 ;
 
-/**
- * replaces all properties with the same name in a destination group from a source group.
- */
 void IDP_ReplaceGroupInGroup(struct IDProperty *dest, struct IDProperty *src)
 #ifdef __GNUC__
 __attribute__((nonnull))
 #endif
 ;
-
-/**
- * Checks if a property with the same name as prop exists, and if so replaces it.
- * Use this to preserve order!*/
 void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop)
 #ifdef __GNUC__
 __attribute__((nonnull))
@@ -160,42 +151,17 @@ __attribute__((nonnull))
 #endif
 ;
 
-/**
- * This function has a sanity check to make sure ID properties with the same name don't
- * get added to the group.
- * 
- * The sanity check just means the property is not added to the group if another property
- * exists with the same name; the client code using ID properties then needs to detect this 
- * (the function that adds new properties to groups, IDP_AddToGroup, returns 0 if a property can't
- * be added to the group, and 1 if it can) and free the property.
- * 
- * Currently the code to free ID properties is designed to leave the actual struct
- * you pass it un-freed, this is needed for how the system works.  This means
- * to free an ID property, you first call IDP_FreeProperty then MEM_freeN the
- * struct.  In the future this will just be IDP_FreeProperty and the code will
- * be reorganized to work properly.
- */
 int IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop)
 #ifdef __GNUC__
 __attribute__((nonnull))
 #endif
 ;
-
-/** this is the same as IDP_AddToGroup, only you pass an item
- * in the group list to be inserted after. */
 int IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous, 
                       struct IDProperty *pnew)
 #ifdef __GNUC__
 __attribute__((nonnull  (1, 3))) /* 'group', 'pnew' */
 #endif
 ;
-
-/** \note this does not free the property!!
- *
- * To free the property, you have to do:
- * IDP_FreeProperty(prop); //free all subdata
- * MEM_freeN(prop); //free property struct itself
- */
 void IDP_RemFromGroup(struct IDProperty *group, struct IDProperty *prop)
 #ifdef __GNUC__
 __attribute__((nonnull))
@@ -208,41 +174,23 @@ __attribute__((warn_unused_result))
 __attribute__((nonnull))
 #endif
 ;
-/** same as above but ensure type match */
 IDProperty *IDP_GetPropertyTypeFromGroup(struct IDProperty *prop, const char *name, const char type)
 #ifdef __GNUC__
 __attribute__((warn_unused_result))
 __attribute__((nonnull))
 #endif
 ;
-
-/**
- * Get an iterator to iterate over the members of an id property group.
- * Note that this will automatically free the iterator once iteration is complete;
- * if you stop the iteration before hitting the end, make sure to call
- * IDP_FreeIterBeforeEnd(). */
 void *IDP_GetGroupIterator(struct IDProperty *prop)
 #ifdef __GNUC__
 __attribute__((warn_unused_result))
 #endif
 ;
-
-/**
- * Returns the next item in the iteration.  To use, simple for a loop like the following:
- * while (IDP_GroupIterNext(iter) != NULL) {
- *     ...
- * }
- */
 IDProperty *IDP_GroupIterNext(void *vself)
 #ifdef __GNUC__
 __attribute__((warn_unused_result))
 __attribute__((nonnull))
 #endif
 ;
-
-/**
- * Frees the iterator pointed to at vself, only use this if iteration is stopped early; 
- * when the iterator hits the end of the list it'll automatically free itself.*/
 void IDP_FreeIterBeforeEnd(void *vself)
 #ifdef __GNUC__
 __attribute__((nonnull))
@@ -250,9 +198,6 @@ __attribute__((nonnull))
 ;
 
 /*-------- Main Functions --------*/
-/** Get the Group property that contains the id properties for ID id.  Set create_if_needed
- * to create the Group property and attach it to id if it doesn't exist; otherwise
- * the function will return NULL if there's no Group property attached to the ID.*/
 struct IDProperty *IDP_GetProperties(struct ID *id, int create_if_needed)
 #ifdef __GNUC__
 __attribute__((warn_unused_result))
@@ -278,31 +223,6 @@ __attribute__((warn_unused_result))
 #endif
 ;
 
-/**
- * Allocate a new ID.
- *
- * This function takes three arguments: the ID property type, a union which defines
- * it's initial value, and a name.
- *
- * The union is simple to use; see the top of this header file for its definition. 
- * An example of using this function:
- *
- *     IDPropertyTemplate val;
- *     IDProperty *group, *idgroup, *color;
- *     group = IDP_New(IDP_GROUP, val, "group1"); //groups don't need a template.
- *    
- *     val.array.len = 4
- *     val.array.type = IDP_FLOAT;
- *     color = IDP_New(IDP_ARRAY, val, "color1");
- *    
- *     idgroup = IDP_GetProperties(some_id, 1);
- *     IDP_AddToGroup(idgroup, color);
- *     IDP_AddToGroup(idgroup, group);
- * 
- * Note that you MUST either attach the id property to an id property group with 
- * IDP_AddToGroup or MEM_freeN the property, doing anything else might result in
- * a memory leak.
- */
 struct IDProperty *IDP_New(const int type, const IDPropertyTemplate *val, const char *name)
 #ifdef __GNUC__
 __attribute__((warn_unused_result))
@@ -310,14 +230,10 @@ __attribute__((nonnull))
 #endif
 ;
 
-/** \note this will free all child properties of list arrays and groups!
- * Also, note that this does NOT unlink anything!  Plus it doesn't free
- * the actual struct IDProperty struct either.*/
 void IDP_FreeProperty(struct IDProperty *prop);
 
 void IDP_ClearProperty(IDProperty *prop);
 
-/** Unlinks any struct IDProperty<->ID linkage that might be going on.*/
 void IDP_UnlinkProperty(struct IDProperty *prop);
 
 #define IDP_Int(prop)                     ((prop)->data.val)