diff options
author | Daniel Veillard <veillard@src.gnome.org> | 2004-01-06 14:17:05 +0000 |
---|---|---|
committer | Daniel Veillard <veillard@src.gnome.org> | 2004-01-06 14:17:05 +0000 |
commit | 5987071fcc901220f357e61c682d2287e9a700c9 (patch) | |
tree | b5fe349760704cacfbfeed4be7299626af490c18 /doc/libxml2-api.xml | |
parent | a2e844a3b3503367a4418187e77ccc977f186909 (diff) | |
download | libxml2-5987071fcc901220f357e61c682d2287e9a700c9.tar.gz |
fixed the comment in the header rebuilt the docs Daniel
* include/libxml/xmlstring.h: fixed the comment in the header
* doc/*: rebuilt the docs
Daniel
Diffstat (limited to 'doc/libxml2-api.xml')
-rw-r--r-- | doc/libxml2-api.xml | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index 749dc759..21d0d037 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -2433,8 +2433,8 @@ <exports symbol='xmlSchemaCheckFacet' type='function'/> </file> <file name='xmlstring'> - <summary>the core parser module</summary> - <description>Interfaces, constants and types related to the XML parser </description> + <summary>set of routines to process strings</summary> + <description>type and interfaces needed for the internal string handling of the library, especially UTF8 processing. </description> <author>Daniel Veillard </author> <exports symbol='BAD_CAST' type='macro'/> <exports symbol='xmlChar' type='typedef'/> @@ -8743,9 +8743,9 @@ actually an xmlCharEncoding'/> <arg name='fp' type='FILE *' info='a FILE descriptor used as the output file, if NULL, the result is written to the file .memorylist'/> </function> <function name='xmlMemFree' file='xmlmemory'> - <info></info> + <info>a free() equivalent, with error checking.</info> <return type='void'/> - <arg name='ptr' type='void *' info=''/> + <arg name='ptr' type='void *' info='the memory block pointer'/> </function> <function name='xmlMemGet' file='xmlmemory'> <info>Provides the memory access functions set currently in use</info> @@ -8756,15 +8756,15 @@ actually an xmlCharEncoding'/> <arg name='strdupFunc' type='xmlStrdupFunc *' info='place to save the strdup() function in use'/> </function> <function name='xmlMemMalloc' file='xmlmemory'> - <info></info> - <return type='void *' info=''/> - <arg name='size' type='size_t' info=''/> + <info>a malloc() equivalent, with logging of the allocation info.</info> + <return type='void *' info='a pointer to the allocated area or NULL in case of lack of memory.'/> + <arg name='size' type='size_t' info='an int specifying the size in byte to allocate.'/> </function> <function name='xmlMemRealloc' file='xmlmemory'> - <info></info> - <return type='void *' info=''/> - <arg name='ptr' type='void *' info=''/> - <arg name='size' type='size_t' info=''/> + <info>a realloc() equivalent, with logging of the allocation info.</info> + <return type='void *' info='a pointer to the allocated area or NULL in case of lack of memory.'/> + <arg name='ptr' type='void *' info='the initial memory block pointer'/> + <arg name='size' type='size_t' info='an int specifying the size in byte to allocate.'/> </function> <function name='xmlMemSetup' file='xmlmemory'> <info>Override the default memory access functions with a new set This has to be called before any other libxml routines ! Should this be blocked if there was already some allocations done ?</info> @@ -8796,9 +8796,9 @@ actually an xmlCharEncoding'/> <return type='void'/> </function> <function name='xmlMemoryStrdup' file='xmlmemory'> - <info></info> - <return type='char *' info=''/> - <arg name='str' type='const char *' info=''/> + <info>a strdup() equivalent, with logging of the allocation info.</info> + <return type='char *' info='a pointer to the new string or NULL if allocation error occurred.'/> + <arg name='str' type='const char *' info='the initial string pointer'/> </function> <function name='xmlMutexLock' file='threads'> <info>xmlMutexLock() is used to lock a libxml2 token.</info> |