mirror of
https://gitlab.gnome.org/GNOME/libxml2.git
synced 2025-10-21 14:53:44 +03:00
doc: Convert documentation to Doxygen
Automated conversion based on a few regexes.
This commit is contained in:
Nick Wellnhofer
161
xmlmemory.c
161
xmlmemory.c
@@ -56,14 +56,13 @@ typedef struct memnod {
|
||||
#define HDR_2_CLIENT(a) ((void *) (((char *) (a)) + RESERVE_SIZE))
|
||||
|
||||
/**
|
||||
* xmlMallocLoc:
|
||||
* @size: an int specifying the size in byte to allocate.
|
||||
* @file: the file name or NULL
|
||||
* @line: the line number
|
||||
* @param size an int specifying the size in byte to allocate.
|
||||
* @param file the file name or NULL
|
||||
* @param line the line number
|
||||
*
|
||||
* DEPRECATED: don't use
|
||||
* @deprecated don't use
|
||||
*
|
||||
* Returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
* @returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
*/
|
||||
void *
|
||||
xmlMallocLoc(size_t size, const char *file ATTRIBUTE_UNUSED,
|
||||
@@ -73,14 +72,13 @@ xmlMallocLoc(size_t size, const char *file ATTRIBUTE_UNUSED,
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMallocAtomicLoc:
|
||||
* @size: an unsigned int specifying the size in byte to allocate.
|
||||
* @file: the file name or NULL
|
||||
* @line: the line number
|
||||
* @param size an unsigned int specifying the size in byte to allocate.
|
||||
* @param file the file name or NULL
|
||||
* @param line the line number
|
||||
*
|
||||
* DEPRECATED: don't use
|
||||
* @deprecated don't use
|
||||
*
|
||||
* Returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
* @returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
*/
|
||||
void *
|
||||
xmlMallocAtomicLoc(size_t size, const char *file ATTRIBUTE_UNUSED,
|
||||
@@ -90,12 +88,11 @@ xmlMallocAtomicLoc(size_t size, const char *file ATTRIBUTE_UNUSED,
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemMalloc:
|
||||
* @size: an int specifying the size in byte to allocate.
|
||||
* @param size an int specifying the size in byte to allocate.
|
||||
*
|
||||
* a malloc() equivalent, with logging of the allocation info.
|
||||
*
|
||||
* Returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
* @returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
*/
|
||||
void *
|
||||
xmlMemMalloc(size_t size)
|
||||
@@ -122,15 +119,14 @@ xmlMemMalloc(size_t size)
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlReallocLoc:
|
||||
* @ptr: the initial memory block pointer
|
||||
* @size: an int specifying the size in byte to allocate.
|
||||
* @file: the file name or NULL
|
||||
* @line: the line number
|
||||
* @param ptr the initial memory block pointer
|
||||
* @param size an int specifying the size in byte to allocate.
|
||||
* @param file the file name or NULL
|
||||
* @param line the line number
|
||||
*
|
||||
* DEPRECATED: don't use
|
||||
* @deprecated don't use
|
||||
*
|
||||
* Returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
* @returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
*/
|
||||
void *
|
||||
xmlReallocLoc(void *ptr, size_t size, const char *file ATTRIBUTE_UNUSED,
|
||||
@@ -140,13 +136,12 @@ xmlReallocLoc(void *ptr, size_t size, const char *file ATTRIBUTE_UNUSED,
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemRealloc:
|
||||
* @ptr: the initial memory block pointer
|
||||
* @size: an int specifying the size in byte to allocate.
|
||||
* @param ptr the initial memory block pointer
|
||||
* @param size an int specifying the size in byte to allocate.
|
||||
*
|
||||
* a realloc() equivalent, with logging of the allocation info.
|
||||
*
|
||||
* Returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
* @returns a pointer to the allocated area or NULL in case of lack of memory.
|
||||
*/
|
||||
void *
|
||||
xmlMemRealloc(void *ptr, size_t size) {
|
||||
@@ -187,8 +182,7 @@ xmlMemRealloc(void *ptr, size_t size) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemFree:
|
||||
* @ptr: the memory block pointer
|
||||
* @param ptr the memory block pointer
|
||||
*
|
||||
* a free() equivalent, with error checking.
|
||||
*/
|
||||
@@ -222,14 +216,13 @@ xmlMemFree(void *ptr)
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemStrdupLoc:
|
||||
* @str: the initial string pointer
|
||||
* @file: the file name or NULL
|
||||
* @line: the line number
|
||||
* @param str the initial string pointer
|
||||
* @param file the file name or NULL
|
||||
* @param line the line number
|
||||
*
|
||||
* DEPRECATED: don't use
|
||||
* @deprecated don't use
|
||||
*
|
||||
* Returns a pointer to the new string or NULL if allocation error occurred.
|
||||
* @returns a pointer to the new string or NULL if allocation error occurred.
|
||||
*/
|
||||
char *
|
||||
xmlMemStrdupLoc(const char *str, const char *file ATTRIBUTE_UNUSED,
|
||||
@@ -239,12 +232,11 @@ xmlMemStrdupLoc(const char *str, const char *file ATTRIBUTE_UNUSED,
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemoryStrdup:
|
||||
* @str: the initial string pointer
|
||||
* @param str the initial string pointer
|
||||
*
|
||||
* a strdup() equivalent, with logging of the allocation info.
|
||||
*
|
||||
* Returns a pointer to the new string or NULL if allocation error occurred.
|
||||
* @returns a pointer to the new string or NULL if allocation error occurred.
|
||||
*/
|
||||
char *
|
||||
xmlMemoryStrdup(const char *str) {
|
||||
@@ -276,10 +268,9 @@ xmlMemoryStrdup(const char *str) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemSize:
|
||||
* @ptr: pointer to the memory allocation
|
||||
* @param ptr pointer to the memory allocation
|
||||
*
|
||||
* Returns the size of a memory allocation.
|
||||
* @returns the size of a memory allocation.
|
||||
*/
|
||||
|
||||
size_t
|
||||
@@ -297,11 +288,10 @@ xmlMemSize(void *ptr) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemUsed:
|
||||
*
|
||||
* Provides the amount of memory currently allocated
|
||||
*
|
||||
* Returns an int representing the amount of memory allocated.
|
||||
* @returns an int representing the amount of memory allocated.
|
||||
*/
|
||||
|
||||
int
|
||||
@@ -310,11 +300,10 @@ xmlMemUsed(void) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemBlocks:
|
||||
*
|
||||
* Provides the number of memory areas currently allocated
|
||||
*
|
||||
* Returns an int representing the number of blocks
|
||||
* @returns an int representing the number of blocks
|
||||
*/
|
||||
|
||||
int
|
||||
@@ -328,11 +317,10 @@ xmlMemBlocks(void) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemDisplayLast:
|
||||
* @fp: a FILE descriptor
|
||||
* @nbBytes: the amount of memory to dump
|
||||
* @param fp a FILE descriptor
|
||||
* @param nbBytes the amount of memory to dump
|
||||
*
|
||||
* DEPRECATED: This feature was removed.
|
||||
* @deprecated This feature was removed.
|
||||
*/
|
||||
void
|
||||
xmlMemDisplayLast(FILE *fp ATTRIBUTE_UNUSED, long nbBytes ATTRIBUTE_UNUSED)
|
||||
@@ -340,10 +328,9 @@ xmlMemDisplayLast(FILE *fp ATTRIBUTE_UNUSED, long nbBytes ATTRIBUTE_UNUSED)
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemDisplay:
|
||||
* @fp: a FILE descriptor
|
||||
* @param fp a FILE descriptor
|
||||
*
|
||||
* DEPRECATED: This feature was removed.
|
||||
* @deprecated This feature was removed.
|
||||
*/
|
||||
void
|
||||
xmlMemDisplay(FILE *fp ATTRIBUTE_UNUSED)
|
||||
@@ -351,11 +338,10 @@ xmlMemDisplay(FILE *fp ATTRIBUTE_UNUSED)
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemShow:
|
||||
* @fp: a FILE descriptor
|
||||
* @nr: number of entries to dump
|
||||
* @param fp a FILE descriptor
|
||||
* @param nr number of entries to dump
|
||||
*
|
||||
* DEPRECATED: This feature was removed.
|
||||
* @deprecated This feature was removed.
|
||||
*/
|
||||
void
|
||||
xmlMemShow(FILE *fp ATTRIBUTE_UNUSED, int nr ATTRIBUTE_UNUSED)
|
||||
@@ -363,9 +349,8 @@ xmlMemShow(FILE *fp ATTRIBUTE_UNUSED, int nr ATTRIBUTE_UNUSED)
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemoryDump:
|
||||
*
|
||||
* DEPRECATED: This feature was removed.
|
||||
* @deprecated This feature was removed.
|
||||
*/
|
||||
void
|
||||
xmlMemoryDump(void)
|
||||
@@ -380,11 +365,10 @@ xmlMemoryDump(void)
|
||||
****************************************************************/
|
||||
|
||||
/**
|
||||
* xmlInitMemory:
|
||||
*
|
||||
* DEPRECATED: Alias for xmlInitParser.
|
||||
* @deprecated Alias for xmlInitParser.
|
||||
*
|
||||
* Returns 0.
|
||||
* @returns 0.
|
||||
*/
|
||||
int
|
||||
xmlInitMemory(void) {
|
||||
@@ -393,7 +377,6 @@ xmlInitMemory(void) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlInitMemoryInternal:
|
||||
*
|
||||
* Initialize the memory layer.
|
||||
*/
|
||||
@@ -403,9 +386,8 @@ xmlInitMemoryInternal(void) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlCleanupMemory:
|
||||
*
|
||||
* DEPRECATED: This function is a no-op. Call xmlCleanupParser
|
||||
* @deprecated This function is a no-op. Call xmlCleanupParser
|
||||
* to free global state but see the warnings there. xmlCleanupParser
|
||||
* should be only called once at program exit. In most cases, you don't
|
||||
* have call cleanup functions at all.
|
||||
@@ -415,7 +397,6 @@ xmlCleanupMemory(void) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlCleanupMemoryInternal:
|
||||
*
|
||||
* Free up all the memory allocated by the library for its own
|
||||
* use. This should not be called by user level code.
|
||||
@@ -435,11 +416,10 @@ xmlCleanupMemoryInternal(void) {
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemSetup:
|
||||
* @freeFunc: the free() function to use
|
||||
* @mallocFunc: the malloc() function to use
|
||||
* @reallocFunc: the realloc() function to use
|
||||
* @strdupFunc: the strdup() function to use
|
||||
* @param freeFunc the free() function to use
|
||||
* @param mallocFunc the malloc() function to use
|
||||
* @param reallocFunc the realloc() function to use
|
||||
* @param strdupFunc the strdup() function to use
|
||||
*
|
||||
* Override the default memory access functions with a new set
|
||||
* This has to be called before any other libxml routines !
|
||||
@@ -447,7 +427,7 @@ xmlCleanupMemoryInternal(void) {
|
||||
* Should this be blocked if there was already some allocations
|
||||
* done ?
|
||||
*
|
||||
* Returns 0 on success
|
||||
* @returns 0 on success
|
||||
*/
|
||||
int
|
||||
xmlMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
|
||||
@@ -469,15 +449,14 @@ xmlMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlMemGet:
|
||||
* @freeFunc: place to save the free() function in use
|
||||
* @mallocFunc: place to save the malloc() function in use
|
||||
* @reallocFunc: place to save the realloc() function in use
|
||||
* @strdupFunc: place to save the strdup() function in use
|
||||
* @param freeFunc place to save the free() function in use
|
||||
* @param mallocFunc place to save the malloc() function in use
|
||||
* @param reallocFunc place to save the realloc() function in use
|
||||
* @param strdupFunc place to save the strdup() function in use
|
||||
*
|
||||
* Provides the memory access functions set currently in use
|
||||
*
|
||||
* Returns 0 on success
|
||||
* @returns 0 on success
|
||||
*/
|
||||
int
|
||||
xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
|
||||
@@ -490,14 +469,13 @@ xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlGcMemSetup:
|
||||
* @freeFunc: the free() function to use
|
||||
* @mallocFunc: the malloc() function to use
|
||||
* @mallocAtomicFunc: the malloc() function to use for atomic allocations
|
||||
* @reallocFunc: the realloc() function to use
|
||||
* @strdupFunc: the strdup() function to use
|
||||
* @param freeFunc the free() function to use
|
||||
* @param mallocFunc the malloc() function to use
|
||||
* @param mallocAtomicFunc the malloc() function to use for atomic allocations
|
||||
* @param reallocFunc the realloc() function to use
|
||||
* @param strdupFunc the strdup() function to use
|
||||
*
|
||||
* DEPRECATED: Use xmlMemSetup.
|
||||
* @deprecated Use xmlMemSetup.
|
||||
*
|
||||
* Override the default memory access functions with a new set
|
||||
* This has to be called before any other libxml routines !
|
||||
@@ -507,7 +485,7 @@ xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
|
||||
* Should this be blocked if there was already some allocations
|
||||
* done ?
|
||||
*
|
||||
* Returns 0 on success
|
||||
* @returns 0 on success
|
||||
*/
|
||||
int
|
||||
xmlGcMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
|
||||
@@ -532,20 +510,19 @@ xmlGcMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
|
||||
}
|
||||
|
||||
/**
|
||||
* xmlGcMemGet:
|
||||
* @freeFunc: place to save the free() function in use
|
||||
* @mallocFunc: place to save the malloc() function in use
|
||||
* @mallocAtomicFunc: place to save the atomic malloc() function in use
|
||||
* @reallocFunc: place to save the realloc() function in use
|
||||
* @strdupFunc: place to save the strdup() function in use
|
||||
* @param freeFunc place to save the free() function in use
|
||||
* @param mallocFunc place to save the malloc() function in use
|
||||
* @param mallocAtomicFunc place to save the atomic malloc() function in use
|
||||
* @param reallocFunc place to save the realloc() function in use
|
||||
* @param strdupFunc place to save the strdup() function in use
|
||||
*
|
||||
* DEPRECATED: xmlMemGet.
|
||||
* @deprecated xmlMemGet.
|
||||
*
|
||||
* Provides the memory access functions set currently in use
|
||||
* The mallocAtomicFunc is specialized for atomic block
|
||||
* allocations (i.e. of areas useful for garbage collected memory allocators
|
||||
*
|
||||
* Returns 0 on success
|
||||
* @returns 0 on success
|
||||
*/
|
||||
int
|
||||
xmlGcMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
|
||||
|
||||
Reference in New Issue
Block a user