From 9a251d59d1e82c57cb4ec5c6e6de6e4e91dcb6d0 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Fri, 8 Aug 2014 14:46:53 +0000 Subject: Use Markdown in doc comments for better source readability. git-svn-id: http://svn.drobilla.net/lad/trunk/plugins/matriseq@5429 a436a847-0d15-0410-975c-d299462d15a1 --- zix/ring.h | 4 ++-- zix/thread.h | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/zix/ring.h b/zix/ring.h index 34ba2fa..f173b6f 100644 --- a/zix/ring.h +++ b/zix/ring.h @@ -1,5 +1,5 @@ /* - Copyright 2011 David Robillard + Copyright 2011-2014 David Robillard Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above @@ -44,7 +44,7 @@ typedef struct ZixRingImpl ZixRing; Create a new ring. @param size Size in bytes (note this may be rounded up). - At most @c size - 1 bytes may be stored in the ring at once. + At most `size - 1` bytes may be stored in the ring at once. */ ZixRing* zix_ring_new(uint32_t size); 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 + Copyright 2012-2014 David Robillard 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); -- cgit v1.2.1