diff options
author | David Robillard <d@drobilla.net> | 2014-08-08 14:46:53 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2014-08-08 14:46:53 +0000 |
commit | abf0666c776298c873f3ff32e4b3874f0b9db357 (patch) | |
tree | 7f7ebe931a9259b69ca60699c8e1050b022cd451 /src/zix | |
parent | b76b671058c363adc196ff165f730f93f4cb841d (diff) | |
download | jalv-abf0666c776298c873f3ff32e4b3874f0b9db357.tar.gz jalv-abf0666c776298c873f3ff32e4b3874f0b9db357.tar.bz2 jalv-abf0666c776298c873f3ff32e4b3874f0b9db357.zip |
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/lad/trunk/jalv@5429 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'src/zix')
-rw-r--r-- | src/zix/sem.h | 4 | ||||
-rw-r--r-- | src/zix/thread.h | 8 |
2 files changed, 6 insertions, 6 deletions
diff --git a/src/zix/sem.h b/src/zix/sem.h index 72c7d8d..6a6dc8e 100644 --- a/src/zix/sem.h +++ b/src/zix/sem.h @@ -59,13 +59,13 @@ extern "C" { typedef struct ZixSemImpl ZixSem; /** - Create and initialize @c sem to @c initial. + Create and initialize `sem` to `initial`. */ static inline ZixStatus zix_sem_init(ZixSem* sem, unsigned initial); /** - Destroy @c sem. + Destroy `sem`. */ static inline void zix_sem_destroy(ZixSem* sem); diff --git a/src/zix/thread.h b/src/zix/thread.h index ff5a727..b007efa 100644 --- a/src/zix/thread.h +++ b/src/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); |