summaryrefslogtreecommitdiff
path: root/glib/gthread.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2013-08-18 18:13:02 -0400
committerMatthias Clasen <mclasen@redhat.com>2013-08-18 18:13:02 -0400
commit635196b1ffc5e810431b5746d52138d2c3bcb1db (patch)
treeb237c296048d3188b221993be2381d17cd343db0 /glib/gthread.c
parent3c040f8534d87782d2ffefd88dfe87cd00393271 (diff)
downloadglib-635196b1ffc5e810431b5746d52138d2c3bcb1db.tar.gz
Expand docs for thread names
Thread names may be NULL, and don't have to be unique. The docs should tell you that.
Diffstat (limited to 'glib/gthread.c')
-rw-r--r--glib/gthread.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/glib/gthread.c b/glib/gthread.c
index c27bca688..c4114aa92 100644
--- a/glib/gthread.c
+++ b/glib/gthread.c
@@ -802,7 +802,7 @@ g_thread_proxy (gpointer data)
/**
* g_thread_new:
- * @name: a name for the new thread
+ * @name: (allow-none): an (optional) name for the new thread
* @func: a function to execute in the new thread
* @data: an argument to supply to the new thread
*
@@ -813,6 +813,7 @@ g_thread_proxy (gpointer data)
* with g_thread_join().
*
* The @name can be useful for discriminating threads in a debugger.
+ * It is not used for other purposes and does not have to be unique.
* Some systems restrict the length of @name to 16 bytes.
*
* If the thread can not be created the program aborts. See
@@ -843,7 +844,7 @@ g_thread_new (const gchar *name,
/**
* g_thread_try_new:
- * @name: a name for the new thread
+ * @name: (allow-none): an (optional) name for the new thread
* @func: a function to execute in the new thread
* @data: an argument to supply to the new thread
* @error: return location for error, or %NULL