Use Markdown in doc comments for better source readability.

git-svn-id: http://svn.drobilla.net/lad/trunk/lilv@5429 a436a847-0d15-0410-975c-d299462d15a1

7 files changed, 29 insertions, 29 deletions

diff --git a/src/node.c b/src/node.c
index c771e40..b57b1b8 100644
--- a/src/node.c
+++ b/src/node.c
@@ -44,7 +44,7 @@ lilv_node_set_numerics_from_string(LilvNode* val, size_t len)
 	}
 }
 
-/** Note that if @a type is numeric or boolean, the returned value is corrupt
+/** Note that if `type` is numeric or boolean, the returned value is corrupt
  * until lilv_node_set_numerics_from_string is called.  It is not
  * automatically called from here to avoid overhead and imprecision when the
  * exact string value is known.
@@ -93,7 +93,7 @@ lilv_node_new(LilvWorld* world, LilvNodeType type, const char* str)
 	return val;
 }
 
-/** Create a new LilvNode from @a node, or return NULL if impossible */
+/** Create a new LilvNode from `node`, or return NULL if impossible */
 LilvNode*
 lilv_node_new_from_node(LilvWorld* world, const SordNode* node)
 {
diff --git a/src/plugin.c b/src/plugin.c
index f88b099..9c966b6 100644
--- a/src/plugin.c
+++ b/src/plugin.c
@@ -32,7 +32,7 @@
 #define NS_DOAP (const uint8_t*)"http://usefulinc.com/ns/doap#"
 #define NS_FOAF (const uint8_t*)"http://xmlns.com/foaf/0.1/"
 
-/** Ownership of @a uri is taken */
+/** Ownership of `uri` is taken */
 LilvPlugin*
 lilv_plugin_new(LilvWorld* world, LilvNode* uri, LilvNode* bundle_uri)
 {
diff --git a/src/state.c b/src/state.c
index b0cec18..68d48f1 100644
--- a/src/state.c
+++ b/src/state.c
@@ -277,7 +277,7 @@ absolute_path(LV2_State_Map_Path_Handle handle,
 	return path;
 }
 
-/** Return a new features array which is @c feature added to @c features. */
+/** Return a new features array which is `feature` added to `features`. */
 static const LV2_Feature**
 add_features(const LV2_Feature *const * features,
              const LV2_Feature* map, const LV2_Feature* make)
diff --git a/src/util.c b/src/util.c
index af92134..f1c9c1c 100644
--- a/src/util.c
+++ b/src/util.c
@@ -165,7 +165,7 @@ append_var(char* dst, size_t* dst_len, const char* var)
 	}
 }
 
-/** Expand variables (e.g. POSIX ~ or $FOO, Windows %FOO%) in @a path. */
+/** Expand variables (e.g. POSIX ~ or $FOO, Windows %FOO%) in `path`. */
 char*
 lilv_expand(const char* path)
 {
@@ -392,7 +392,7 @@ update_latest(const char* path, const char* name, void* data)
 	}
 }
 
-/** Return the latest copy of the file at @c path that is newer. */
+/** Return the latest copy of the file at `path` that is newer. */
 char*
 lilv_get_latest_copy(const char* path, const char* copy_path)
 {
diff --git a/src/world.c b/src/world.c
index 8983e40..41fe16f 100644
--- a/src/world.c
+++ b/src/world.c
@@ -661,7 +661,7 @@ load_dir_entry(const char* dir, const char* name, void* data)
 	free(uri);
 }
 
-/** Load all bundles in the directory at @a dir_path. */
+/** Load all bundles in the directory at `dir_path`. */
 static void
 lilv_world_load_directory(LilvWorld* world, const char* dir_path)
 {
@@ -683,7 +683,7 @@ first_path_sep(const char* path)
 	return NULL;
 }
 
-/** Load all bundles found in @a lv2_path.
+/** Load all bundles found in `lv2_path`.
  * @param lv2_path A colon-delimited list of directories.  These directories
  * should contain LV2 bundle directories (ie the search path is a list of
  * parent directories of bundles, not a list of bundle directories).
diff --git a/src/zix/tree.c b/src/zix/tree.c
index 9915e89..1646709 100644
--- a/src/zix/tree.c
+++ b/src/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/src/zix/tree.h b/src/zix/tree.h
index 4b6e039..e531a9b 100644
--- a/src/zix/tree.h
+++ b/src/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
@@ -38,7 +38,7 @@ extern "C" {
 typedef struct ZixTreeImpl ZixTree;
 
 /**
-   An iterator over a @ref ZixTree.
+   An iterator over a ZixTree.
 */
 typedef struct ZixTreeNodeImpl ZixTreeIter;
 
@@ -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);