Changed multi-line C comments into another style.
The left side doesn't look unbalanced.
This commit is contained in:
@@ -81,8 +81,8 @@ Collection* InitCollection (Collection* C);
|
||||
|
||||
void DoneCollection (Collection* C);
|
||||
/* Free the data for a collection. This will not free the data contained in
|
||||
* the collection.
|
||||
*/
|
||||
** the collection.
|
||||
*/
|
||||
|
||||
Collection* NewCollection (void);
|
||||
/* Create and return a new collection */
|
||||
@@ -92,9 +92,9 @@ void FreeCollection (Collection* C);
|
||||
|
||||
void CollGrow (Collection* C, unsigned Size);
|
||||
/* Grow the collection C so it is able to hold Size items without a resize
|
||||
* being necessary. This can be called for performance reasons if the number
|
||||
* of items to be placed in the collection is known in advance.
|
||||
*/
|
||||
** being necessary. This can be called for performance reasons if the number
|
||||
** of items to be placed in the collection is known in advance.
|
||||
*/
|
||||
|
||||
#if defined(HAVE_INLINE)
|
||||
INLINE unsigned CollCount (const Collection* C)
|
||||
@@ -195,8 +195,8 @@ const void* CollConstLast (const Collection* C);
|
||||
#if defined(HAVE_INLINE)
|
||||
INLINE void* CollPop (Collection* C)
|
||||
/* Remove the last segment from the stack and return it. Calls FAIL if the
|
||||
* collection is empty.
|
||||
*/
|
||||
** collection is empty.
|
||||
*/
|
||||
{
|
||||
/* We must have at least one entry */
|
||||
PRECONDITION (C->Count > 0);
|
||||
@@ -207,31 +207,31 @@ INLINE void* CollPop (Collection* C)
|
||||
#else
|
||||
void* CollPop (Collection* C);
|
||||
/* Remove the last segment from the stack and return it. Calls FAIL if the
|
||||
* collection is empty.
|
||||
*/
|
||||
** collection is empty.
|
||||
*/
|
||||
#endif
|
||||
|
||||
int CollIndex (Collection* C, const void* Item);
|
||||
/* Return the index of the given item in the collection. Return -1 if the
|
||||
* item was not found in the collection.
|
||||
*/
|
||||
** item was not found in the collection.
|
||||
*/
|
||||
|
||||
void CollDelete (Collection* C, unsigned Index);
|
||||
/* Remove the item with the given index from the collection. This will not
|
||||
* free the item itself, just the pointer. All items with higher indices
|
||||
* will get moved to a lower position.
|
||||
*/
|
||||
** free the item itself, just the pointer. All items with higher indices
|
||||
** will get moved to a lower position.
|
||||
*/
|
||||
|
||||
void CollDeleteItem (Collection* C, const void* Item);
|
||||
/* Delete the item pointer from the collection. The item must be in the
|
||||
* collection, otherwise FAIL will be called.
|
||||
*/
|
||||
** collection, otherwise FAIL will be called.
|
||||
*/
|
||||
|
||||
#if defined(HAVE_INLINE)
|
||||
INLINE void CollDeleteAll (Collection* C)
|
||||
/* Delete all items from the given collection. This will not free the items
|
||||
* itself, it will only remove the pointers.
|
||||
*/
|
||||
** itself, it will only remove the pointers.
|
||||
*/
|
||||
{
|
||||
/* This one is easy... */
|
||||
C->Count = 0;
|
||||
@@ -243,8 +243,8 @@ INLINE void CollDeleteAll (Collection* C)
|
||||
#if defined(HAVE_INLINE)
|
||||
INLINE void CollReplace (Collection* C, void* Item, unsigned Index)
|
||||
/* Replace the item at the given position. The old item will not be freed,
|
||||
* just the pointer will get replaced.
|
||||
*/
|
||||
** just the pointer will get replaced.
|
||||
*/
|
||||
{
|
||||
/* Check the index */
|
||||
PRECONDITION (Index < C->Count);
|
||||
@@ -255,46 +255,46 @@ INLINE void CollReplace (Collection* C, void* Item, unsigned Index)
|
||||
#else
|
||||
void CollReplace (Collection* C, void* Item, unsigned Index);
|
||||
/* Replace the item at the given position. The old item will not be freed,
|
||||
* just the pointer will get replaced.
|
||||
*/
|
||||
** just the pointer will get replaced.
|
||||
*/
|
||||
#endif
|
||||
|
||||
void CollReplaceExpand (Collection* C, void* Item, unsigned Index);
|
||||
/* If Index is a valid index for the collection, replace the item at this
|
||||
* position by the one passed. If the collection is too small, expand it,
|
||||
* filling unused pointers with NULL, then add the new item at the given
|
||||
* position.
|
||||
*/
|
||||
** position by the one passed. If the collection is too small, expand it,
|
||||
** filling unused pointers with NULL, then add the new item at the given
|
||||
** position.
|
||||
*/
|
||||
|
||||
void CollMove (Collection* C, unsigned OldIndex, unsigned NewIndex);
|
||||
/* Move an item from one position in the collection to another. OldIndex
|
||||
* is the current position of the item, NewIndex is the new index after
|
||||
* the function has done it's work. Existing entries with indices NewIndex
|
||||
* and up are moved one position upwards.
|
||||
*/
|
||||
** is the current position of the item, NewIndex is the new index after
|
||||
** the function has done it's work. Existing entries with indices NewIndex
|
||||
** and up are moved one position upwards.
|
||||
*/
|
||||
|
||||
void CollMoveMultiple (Collection* C, unsigned Start, unsigned Count, unsigned Target);
|
||||
/* Move a range of items from one position to another. Start is the index
|
||||
* of the first item to move, Count is the number of items and Target is
|
||||
* the index of the target item. The item with the index Start will later
|
||||
* have the index Target. All items with indices Target and above are moved
|
||||
* to higher indices.
|
||||
*/
|
||||
** of the first item to move, Count is the number of items and Target is
|
||||
** the index of the target item. The item with the index Start will later
|
||||
** have the index Target. All items with indices Target and above are moved
|
||||
** to higher indices.
|
||||
*/
|
||||
|
||||
void CollTransfer (Collection* Dest, const Collection* Source);
|
||||
/* Transfer all items from Source to Dest. Anything already in Dest is left
|
||||
* untouched. The items in Source are not changed and are therefore in both
|
||||
* Collections on return.
|
||||
*/
|
||||
** untouched. The items in Source are not changed and are therefore in both
|
||||
** Collections on return.
|
||||
*/
|
||||
|
||||
void CollSort (Collection* C,
|
||||
int (*Compare) (void*, const void*, const void*),
|
||||
void* Data);
|
||||
/* Sort the collection using the given compare function. The data pointer is
|
||||
* passed as *first* element to the compare function, it's not used by the
|
||||
* sort function itself. The other two pointer passed to the Compare function
|
||||
* are pointers to objects.
|
||||
*/
|
||||
** passed as *first* element to the compare function, it's not used by the
|
||||
** sort function itself. The other two pointer passed to the Compare function
|
||||
** are pointers to objects.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user