Use Markdown for parameters in dox comments.

git-svn-id: http://svn.drobilla.net/zix/trunk@93 df6676b4-ccc9-40e5-b5d6-7c4628a128e3

9 files changed, 57 insertions, 58 deletions

diff --git a/zix/fat_patree.h b/zix/fat_patree.h
index bc3bd66..2fb1b4d 100644
--- a/zix/fat_patree.h
+++ b/zix/fat_patree.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
@@ -36,28 +36,28 @@ ZixFatPatree*
 zix_fat_patree_new(void);
 
 /**
-   Destroy @a t.
+   Destroy `t`.
 */
 ZIX_API
 void
 zix_fat_patree_free(ZixFatPatree* t);
 
 /**
-   Print a DOT description of @a t to @a fd.
+   Print a DOT description of `t` to `fd`.
 */
 ZIX_API
 void
 zix_fat_patree_print_dot(const ZixFatPatree* t, FILE* fd);
 
 /**
-   Insert @a str into @a t.
+   Insert `str` into `t`.
 */
 ZIX_API
 ZixStatus
 zix_fat_patree_insert(ZixFatPatree* t, const char* str);
 
 /**
-   Search for @a str in @a t.
+   Search for `str` in `t`.
 */
 ZIX_API
 ZixStatus
diff --git a/zix/patree.h b/zix/patree.h
index 09f3538..c89bc9b 100644
--- a/zix/patree.h
+++ b/zix/patree.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
@@ -36,28 +36,28 @@ ZixPatree*
 zix_patree_new(void);
 
 /**
-   Destroy @a t.
+   Destroy `t`.
 */
 ZIX_API
 void
 zix_patree_free(ZixPatree* t);
 
 /**
-   Print a DOT description of @a t to @a fd.
+   Print a DOT description of `t` to `fd`.
 */
 ZIX_API
 void
 zix_patree_print_dot(const ZixPatree* t, FILE* fd);
 
 /**
-   Insert @a str into @a t.
+   Insert `str` into `t`.
 */
 ZIX_API
 ZixStatus
 zix_patree_insert(ZixPatree* t, const char* str);
 
 /**
-   Search for @a str in @a t.
+   Search for `str` in `t`.
 */
 ZIX_API
 ZixStatus
diff --git a/zix/ring.h b/zix/ring.h
index 34ba2fa..f7f1893 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/sem.h b/zix/sem.h
index 0d05910..a7cb826 100644
--- a/zix/sem.h
+++ b/zix/sem.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
@@ -60,13 +60,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/zix/sorted_array.h b/zix/sorted_array.h
index 8a846ec..c10c2b6 100644
--- a/zix/sorted_array.h
+++ b/zix/sorted_array.h
@@ -1,6 +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
@@ -50,21 +49,21 @@ zix_sorted_array_new(bool allow_duplicates, ZixComparator cmp, void* cmp_data,
                      size_t elem_size);
 
 /**
-   Free @a a.
+   Free `a`.
 */
 ZIX_API
 void
 zix_sorted_array_free(ZixSortedArray* a);
 
 /**
-   Return the number of elements in @a a.
+   Return the number of elements in `a`.
 */
 ZIX_API
 size_t
 zix_sorted_array_size(ZixSortedArray* a);
 
 /**
-   Insert the element @a e into @a a and point @a ai at the new element.
+   Insert the element `e` into `a` and point `ai` at the new element.
 */
 ZIX_API
 ZixStatus
@@ -73,15 +72,15 @@ zix_sorted_array_insert(ZixSortedArray*     a,
                         ZixSortedArrayIter* ai);
 
 /**
-   Remove the item pointed at by @a ai from @a a.
+   Remove the item pointed at by `ai` from `a`.
 */
 ZIX_API
 ZixStatus
 zix_sorted_array_remove(ZixSortedArray* a, ZixSortedArrayIter ai);
 
 /**
-   Set @a ai to be the largest element <= @a e in @a a.
-   If no such item exists, @a ai is set to NULL.
+   Set `ai` to be the largest element <= `e` in `a`.
+   If no such item exists, `ai` is set to NULL.
 */
 ZIX_API
 ZixStatus
@@ -90,7 +89,7 @@ zix_sorted_array_find(const ZixSortedArray* a,
                       ZixSortedArrayIter*   ai);
 
 /**
-   Return the element at index @a index.
+   Return the element at index `index`.
 */
 ZIX_API
 void*
@@ -104,28 +103,28 @@ void*
 zix_sorted_array_get_data(ZixSortedArrayIter ai);
 
 /**
-   Return an iterator to the first (smallest) element in @a a.
+   Return an iterator to the first (smallest) element in `a`.
 */
 ZIX_API
 ZixSortedArrayIter
 zix_sorted_array_begin(ZixSortedArray* a);
 
 /**
-   Return an iterator the the element one past the last element in @a a.
+   Return an iterator the the element one past the last element in `a`.
 */
 ZIX_API
 ZixSortedArrayIter
 zix_sorted_array_end(ZixSortedArray* a);
 
 /**
-   Return true iff @a a is an iterator to the end of its tree.
+   Return true iff `a` is an iterator to the end of its tree.
 */
 ZIX_API
 bool
 zix_sorted_array_iter_is_end(ZixSortedArray* a, ZixSortedArrayIter i);
 
 /**
-   Return an iterator that points to the element one past @a a.
+   Return an iterator that points to the element one past `a`.
 */
 ZIX_API
 ZixSortedArrayIter
diff --git a/zix/strindex.h b/zix/strindex.h
index 628b92a..ba95d81 100644
--- a/zix/strindex.h
+++ b/zix/strindex.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
@@ -29,23 +29,23 @@
 typedef struct _ZixStrindex ZixStrindex;
 
 /**
-   Construct a new strindex that contains all suffixes of the string @a s.
-   A copy of @a s is taken and stored for the lifetime of the strindex.
+   Construct a new strindex that contains all suffixes of the string `s`.
+   A copy of `s` is taken and stored for the lifetime of the strindex.
 */
 ZIX_API
 ZixStrindex*
 zix_strindex_new(const char* s);
 
 /**
-   Destroy @a t.
+   Destroy `t`.
 */
 ZIX_API
 void
 zix_strindex_free(ZixStrindex* strindex);
 
 /**
-   Check if the string in @a strindex contains the substring @a str.
-   If such a substring is found, @a match is pointed at an occurrence of it.
+   Check if the string in `strindex` contains the substring `str`.
+   If such a substring is found, `match` is pointed at an occurrence of it.
 */
 ZIX_API
 ZixStatus
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);
diff --git a/zix/tree.c b/zix/tree.c
index 9915e89..1646709 100644
--- a/zix/tree.c
+++ b/zix/tree.c
@@ -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
@@ -146,7 +146,7 @@ rotate(ZixTreeNode* p, ZixTreeNode* q)
 }
 
 /**
- * Rotate left about @a p.
+ * Rotate left about `p`.
  *
  *    p              q
  *   / \            / \
@@ -178,7 +178,7 @@ rotate_left(ZixTreeNode* p, int* height_change)
 }
 
 /**
- * Rotate right about @a p.
+ * Rotate right about `p`.
  *
  *      p          q
  *     / \        / \
@@ -211,7 +211,7 @@ rotate_right(ZixTreeNode* p, int* height_change)
 }
 
 /**
- * Rotate left about @a p->left then right about @a p.
+ * Rotate left about `p->left` then right about `p`.
  *
  *      p             r
  *     / \           / \
@@ -255,7 +255,7 @@ rotate_left_right(ZixTreeNode* p, int* height_change)
 }
 
 /**
- * Rotate right about @a p->right then right about @a p.
+ * Rotate right about `p->right` then right about `p`.
  *
  *    p               r
  *   / \             / \
diff --git a/zix/tree.h b/zix/tree.h
index 4b6e039..c18ae3d 100644
--- a/zix/tree.h
+++ b/zix/tree.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
@@ -52,32 +52,32 @@ zix_tree_new(bool           allow_duplicates,
              ZixDestroyFunc destroy);
 
 /**
-   Free @a t.
+   Free `t`.
 */
 ZIX_API void
 zix_tree_free(ZixTree* t);
 
 /**
-   Return the number of elements in @a t.
+   Return the number of elements in `t`.
 */
 ZIX_API size_t
 zix_tree_size(const ZixTree* t);
 
 /**
-   Insert the element @a e into @a t and point @a ti at the new element.
+   Insert the element `e` into `t` and point `ti` at the new element.
 */
 ZIX_API ZixStatus
 zix_tree_insert(ZixTree* t, void* e, ZixTreeIter** ti);
 
 /**
-   Remove the item pointed at by @a ti from @a t.
+   Remove the item pointed at by `ti` from `t`.
 */
 ZIX_API ZixStatus
 zix_tree_remove(ZixTree* t, ZixTreeIter* ti);
 
 /**
-   Set @a ti to an element equal to @a e in @a t.
-   If no such item exists, @a ti is set to NULL.
+   Set `ti` to an element equal to `e` in `t`.
+   If no such item exists, `ti` is set to NULL.
 */
 ZIX_API ZixStatus
 zix_tree_find(const ZixTree* t, const void* e, ZixTreeIter** ti);
@@ -89,49 +89,49 @@ ZIX_API void*
 zix_tree_get(const ZixTreeIter* ti);
 
 /**
-   Return an iterator to the first (smallest) element in @a t.
+   Return an iterator to the first (smallest) element in `t`.
 */
 ZIX_API ZixTreeIter*
 zix_tree_begin(ZixTree* t);
 
 /**
-   Return an iterator the the element one past the last element in @a t.
+   Return an iterator the the element one past the last element in `t`.
 */
 ZIX_API ZixTreeIter*
 zix_tree_end(ZixTree* t);
 
 /**
-   Return true iff @a i is an iterator to the end of its tree.
+   Return true iff `i` is an iterator to the end of its tree.
 */
 ZIX_API bool
 zix_tree_iter_is_end(const ZixTreeIter* i);
 
 /**
-   Return an iterator to the last (largest) element in @a t.
+   Return an iterator to the last (largest) element in `t`.
 */
 ZIX_API ZixTreeIter*
 zix_tree_rbegin(ZixTree* t);
 
 /**
-   Return an iterator the the element one before the first element in @a t.
+   Return an iterator the the element one before the first element in `t`.
 */
 ZIX_API ZixTreeIter*
 zix_tree_rend(ZixTree* t);
 
 /**
-   Return true iff @a i is an iterator to the reverse end of its tree.
+   Return true iff `i` is an iterator to the reverse end of its tree.
 */
 ZIX_API bool
 zix_tree_iter_is_rend(const ZixTreeIter* i);
 
 /**
-   Return an iterator that points to the element one past @a i.
+   Return an iterator that points to the element one past `i`.
 */
 ZIX_API ZixTreeIter*
 zix_tree_iter_next(ZixTreeIter* i);
 
 /**
-   Return an iterator that points to the element one before @a i.
+   Return an iterator that points to the element one before `i`.
 */
 ZIX_API ZixTreeIter*
 zix_tree_iter_prev(ZixTreeIter* i);