From 7802271bf026627f983c5b95714a67cc1a700860 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Thu, 6 Feb 2003 19:57:14 +0000 Subject: [PATCH] Fix a bunch of typos in header comments. (#102422, Morten Welinder) 2003-02-06 Matthias Clasen * glib/gmessages.h: * glib/gmem.h: * glib/ghash.h: * glib/gasyncqueue.h: * glib/garray.h: * glib/ghook.h: * glib/gtypes.h: Fix a bunch of typos in header comments. (#102422, Morten Welinder) --- glib/garray.h | 9 ++++----- glib/gasyncqueue.h | 24 ++++++++++++------------ glib/ghash.h | 6 +++--- glib/ghook.h | 2 +- glib/gmem.h | 6 +++--- glib/gmessages.h | 2 +- glib/gtypes.h | 2 +- 7 files changed, 25 insertions(+), 26 deletions(-) diff --git a/glib/garray.h b/glib/garray.h index bccd91a..c29d152 100644 --- a/glib/garray.h +++ b/glib/garray.h @@ -53,9 +53,9 @@ struct _GPtrArray guint len; }; -/* Resizable arrays, remove fills any cleared spot and shortens the +/* Resizable arrays. remove fills any cleared spot and shortens the * array, while preserving the order. remove_fast will distort the - * order by moving the last element to the position of the removed + * order by moving the last element to the position of the removed. */ #define g_array_append_val(a,v) g_array_append_vals (a, &(v), 1) @@ -95,9 +95,8 @@ void g_array_sort_with_data (GArray *array, gpointer user_data); /* Resizable pointer array. This interface is much less complicated - * than the above. Add appends appends a pointer. Remove fills any - * cleared spot and shortens the array. remove_fast will again distort - * order. + * than the above. Add appends a pointer. Remove fills any cleared + * spot and shortens the array. remove_fast will again distort order. */ #define g_ptr_array_index(array,index_) ((array)->pdata)[index_] GPtrArray* g_ptr_array_new (void); diff --git a/glib/gasyncqueue.h b/glib/gasyncqueue.h index 0f1a80d..bfc7b69 100644 --- a/glib/gasyncqueue.h +++ b/glib/gasyncqueue.h @@ -39,9 +39,9 @@ typedef struct _GAsyncQueue GAsyncQueue; /* Get a new GAsyncQueue with the ref_count 1 */ GAsyncQueue* g_async_queue_new (void); -/* Lock and unlock an GAsyncQueue, all functions lock the queue for +/* Lock and unlock a GAsyncQueue. All functions lock the queue for * themselves, but in certain cirumstances you want to hold the lock longer, - * thus you lock the queue, call the *_unlocked functions and unlock it again + * thus you lock the queue, call the *_unlocked functions and unlock it again. */ void g_async_queue_lock (GAsyncQueue *queue); void g_async_queue_unlock (GAsyncQueue *queue); @@ -52,39 +52,39 @@ void g_async_queue_unlock (GAsyncQueue *queue); * lock (g_async_queue_unref) and one to call, when you already hold * the lock (g_async_queue_unref_and_unlock). After that however, you * don't hold the lock anymore and the Queue might in fact be - * destroyed, if you unrefed to zero */ + * destroyed, if you unrefed to zero. */ void g_async_queue_ref (GAsyncQueue *queue); void g_async_queue_ref_unlocked (GAsyncQueue *queue); void g_async_queue_unref (GAsyncQueue *queue); void g_async_queue_unref_and_unlock (GAsyncQueue *queue); -/* Push data into the async queue. Must not be NULL */ +/* Push data into the async queue. Must not be NULL. */ void g_async_queue_push (GAsyncQueue *queue, gpointer data); void g_async_queue_push_unlocked (GAsyncQueue *queue, gpointer data); -/* Pop data from the async queue, when no data is there, the thread is blocked - * until data arrives */ +/* Pop data from the async queue. When no data is there, the thread is blocked + * until data arrives. */ gpointer g_async_queue_pop (GAsyncQueue *queue); gpointer g_async_queue_pop_unlocked (GAsyncQueue *queue); -/* Try to pop data, NULL is returned in case of empty queue */ +/* Try to pop data. NULL is returned in case of empty queue. */ gpointer g_async_queue_try_pop (GAsyncQueue *queue); gpointer g_async_queue_try_pop_unlocked (GAsyncQueue *queue); -/* Wait for data until at maximum until end_time is reached, NULL is returned - * in case of empty queue*/ +/* Wait for data until at maximum until end_time is reached. NULL is returned + * in case of empty queue. */ gpointer g_async_queue_timed_pop (GAsyncQueue *queue, GTimeVal *end_time); gpointer g_async_queue_timed_pop_unlocked (GAsyncQueue *queue, GTimeVal *end_time); -/* Return the length of the queue, negative values mean, that threads - * are waiting, positve values mean, that there are entries in the +/* Return the length of the queue. Negative values mean that threads + * are waiting, positve values mean that there are entries in the * queue. Actually this function returns the length of the queue minus * the number of waiting threads, g_async_queue_length == 0 could also - * mean 'n' entries in the queue and 'n' thread waiting, such can + * mean 'n' entries in the queue and 'n' thread waiting. Such can * happen due to locking of the queue or due to scheduling. */ gint g_async_queue_length (GAsyncQueue *queue); gint g_async_queue_length_unlocked (GAsyncQueue *queue); diff --git a/glib/ghash.h b/glib/ghash.h index fccff0e..a305121 100644 --- a/glib/ghash.h +++ b/glib/ghash.h @@ -92,10 +92,10 @@ gboolean g_int_equal (gconstpointer v, gconstpointer v2); guint g_int_hash (gconstpointer v); -/* This "hash" function will just return the key's adress as an - * unsigned integer. Useful for hashing on plain adresses or +/* This "hash" function will just return the key's address as an + * unsigned integer. Useful for hashing on plain addresses or * simple integer values. - * passing NULL into g_hash_table_new() as GHashFunc has the + * Passing NULL into g_hash_table_new() as GHashFunc has the * same effect as passing g_direct_hash(). */ guint g_direct_hash (gconstpointer v) G_GNUC_CONST; diff --git a/glib/ghook.h b/glib/ghook.h index 1eb52e0..422284c 100644 --- a/glib/ghook.h +++ b/glib/ghook.h @@ -98,7 +98,7 @@ struct _GHook /* --- prototypes --- */ -/* callback mainenance functions */ +/* callback maintenance functions */ void g_hook_list_init (GHookList *hook_list, guint hook_size); void g_hook_list_clear (GHookList *hook_list); diff --git a/glib/gmem.h b/glib/gmem.h index 7016847..4071c0a 100644 --- a/glib/gmem.h +++ b/glib/gmem.h @@ -122,11 +122,11 @@ void g_mem_profile (void); * want to know what's going on inside do you?) */ -/* ALLOC_ONLY MemChunk's can only allocate memory. The free operation - * is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per +/* ALLOC_ONLY MemChunks can only allocate memory. The free operation + * is interpreted as a no op. ALLOC_ONLY MemChunks save 4 bytes per * atom. (They are also useful for lists which use MemChunk to allocate * memory but are also part of the MemChunk implementation). - * ALLOC_AND_FREE MemChunk's can allocate and free memory. + * ALLOC_AND_FREE MemChunks can allocate and free memory. */ #define G_ALLOC_ONLY 1 diff --git a/glib/gmessages.h b/glib/gmessages.h index cc36388..f3946ff 100644 --- a/glib/gmessages.h +++ b/glib/gmessages.h @@ -39,7 +39,7 @@ G_BEGIN_DECLS -/* calculate a string size, guarranteed to fit format + args. +/* calculate a string size, guaranteed to fit format + args. */ gsize g_printf_string_upper_bound (const gchar* format, va_list args); diff --git a/glib/gtypes.h b/glib/gtypes.h index 9ca8f69..237733d 100644 --- a/glib/gtypes.h +++ b/glib/gtypes.h @@ -330,7 +330,7 @@ typedef union _GDoubleIEEE754 GDoubleIEEE754; typedef union _GFloatIEEE754 GFloatIEEE754; #define G_IEEE754_FLOAT_BIAS (127) #define G_IEEE754_DOUBLE_BIAS (1023) -/* multiply with base2 exponent to get base10 exponent (nomal numbers) */ +/* multiply with base2 exponent to get base10 exponent (normal numbers) */ #define G_LOG_2_BASE_10 (0.30102999566398119521) #if G_BYTE_ORDER == G_LITTLE_ENDIAN union _GFloatIEEE754 -- 2.7.4