summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 14:46:53 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 14:46:53 +0000
commit9a251d59d1e82c57cb4ec5c6e6de6e4e91dcb6d0 (patch)
tree0469b58af927b110b194b4db7bdc2e013e690fc7
parentc3dae6920fd64be020a543cec3a08281be1bb32c (diff)
downloadmatriseq.lv2-9a251d59d1e82c57cb4ec5c6e6de6e4e91dcb6d0.tar.gz
matriseq.lv2-9a251d59d1e82c57cb4ec5c6e6de6e4e91dcb6d0.tar.bz2
matriseq.lv2-9a251d59d1e82c57cb4ec5c6e6de6e4e91dcb6d0.zip
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
-rw-r--r--zix/ring.h4
-rw-r--r--zix/thread.h8
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 <http://drobilla.net>
+ Copyright 2011-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
@@ -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 <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);