diff options
| author | David Robillard <d@drobilla.net> | 2014-09-28 17:49:03 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2014-09-28 17:49:03 +0000 |
| commit | b7d81e0674af26a326fad1d600012d1a9e2a05ae (patch) | |
| tree | aa8300de4cc458e77de607bbb4bd7b1fa12016b2 /zix/thread.h | |
| parent | df41412520ae9962a3a833ccb5b2dd408abd43ed (diff) | |
| download | zix-b7d81e0674af26a326fad1d600012d1a9e2a05ae.tar.gz zix-b7d81e0674af26a326fad1d600012d1a9e2a05ae.tar.bz2 zix-b7d81e0674af26a326fad1d600012d1a9e2a05ae.zip | |
Use Markdown for parameters in dox comments.
git-svn-id: http://svn.drobilla.net/zix/trunk@93 df6676b4-ccc9-40e5-b5d6-7c4628a128e3
Diffstat (limited to 'zix/thread.h')
| -rw-r--r-- | zix/thread.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/zix/thread.h b/zix/thread.h index ff5a727..b007efa 100644 --- a/zix/thread.h +++ b/zix/thread.h @@ -1,5 +1,5 @@ /* - Copyright 2012 David Robillard <http://drobilla.net> + Copyright 2012-2014 David Robillard <http://drobilla.net> Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above @@ -46,9 +46,9 @@ typedef pthread_t ZixThread; #endif /** - Initialize @c thread to a new thread. + Initialize `thread` to a new thread. - The thread will immediately be launched, calling @c function with @c arg + The thread will immediately be launched, calling `function` with `arg` as the only parameter. */ static inline ZixStatus @@ -58,7 +58,7 @@ zix_thread_create(ZixThread* thread, void* arg); /** - Join @c thread (block until @c thread exits). + Join `thread` (block until `thread` exits). */ static inline ZixStatus zix_thread_join(ZixThread thread, void** retval); |