Minor edits, mostly tweaks of the API documentation

darcs-hash:20060123233347-ac50b-44ebb96ba202c062739ba3d183519e28a95511b2.gz
This commit is contained in:
axel 2006-01-24 09:33:47 +10:00
parent ba177b48d5
commit 8df21a1cb1
3 changed files with 52 additions and 36 deletions

View file

@ -823,8 +823,6 @@ static int builtin_functions( wchar_t **argv )
} }
/* /*
Erase, desc and list are mutually exclusive Erase, desc and list are mutually exclusive
*/ */
@ -840,7 +838,6 @@ static int builtin_functions( wchar_t **argv )
return 1; return 1;
} }
if( erase ) if( erase )
{ {
int i; int i;

View file

@ -1234,7 +1234,7 @@ static const wchar_t *complete_function_desc( const wchar_t *fn )
\param cmd the command string to find completions for \param cmd the command string to find completions for
B\param comp the list to add all completions to \param comp the list to add all completions to
*/ */
static void complete_cmd( const wchar_t *cmd, static void complete_cmd( const wchar_t *cmd,
array_list_t *comp ) array_list_t *comp )

33
util.h
View file

@ -165,19 +165,29 @@ float minf( float a, float b );
*/ */
void q_init( dyn_queue_t *q ); void q_init( dyn_queue_t *q );
/** Destroy the queue */ /**
Destroy the queue
*/
void q_destroy( dyn_queue_t *q ); void q_destroy( dyn_queue_t *q );
/** Insert element into queue */ /**
Insert element into queue
*/
int q_put( dyn_queue_t *q, void *e ); int q_put( dyn_queue_t *q, void *e );
/** Remove and return next element from queue */ /**
Remove and return next element from queue
*/
void *q_get( dyn_queue_t *q); void *q_get( dyn_queue_t *q);
/** Return next element from queue without removing it */ /**
Return next element from queue without removing it
*/
void *q_peek( dyn_queue_t *q); void *q_peek( dyn_queue_t *q);
/** Returns 1 if the queue is empty, 0 otherwise */ /**
Returns 1 if the queue is empty, 0 otherwise
*/
int q_empty( dyn_queue_t *q ); int q_empty( dyn_queue_t *q );
/** /**
@ -273,7 +283,8 @@ int hash_str_func( const void *data );
/** /**
Hash comparison function suitable for character strings Hash comparison function suitable for character strings
*/ */
int hash_str_cmp( const void *a, const void *b ); int hash_str_cmp( const void *a,
const void *b );
/** /**
Hash function suitable for wide character strings. Hash function suitable for wide character strings.
@ -283,7 +294,8 @@ int hash_wcs_func( const void *data );
/** /**
Hash comparison function suitable for wide character strings Hash comparison function suitable for wide character strings
*/ */
int hash_wcs_cmp( const void *a, const void *b ); int hash_wcs_cmp( const void *a,
const void *b );
/** /**
Initialize the priority queue Initialize the priority queue
@ -445,6 +457,10 @@ void al_foreach2( array_list_t *l, void (*func)(const void *, void *), void *aux
int wcsfilecmp( const wchar_t *a, const wchar_t *b ); int wcsfilecmp( const wchar_t *a, const wchar_t *b );
/*
String buffer functions
*/
/** /**
Initialize the specified string_buffer Initialize the specified string_buffer
*/ */
@ -503,6 +519,9 @@ void sb_destroy( string_buffer_t * );
*/ */
void sb_clear( string_buffer_t * ); void sb_clear( string_buffer_t * );
/*
Buffer functions
*/
/** /**
Initialize the specified buffer_t Initialize the specified buffer_t