summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 06:11:57 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 06:11:57 +0000
commitc816ee27e8a2f235558105940c39b1033556d9f9 (patch)
treef9f00aa180511d19f2d79192f0469e50128925a4
parent52fda35629b017cf6b1c697644e6fa8c17ccd174 (diff)
downloadsord-c816ee27e8a2f235558105940c39b1033556d9f9.tar.gz
sord-c816ee27e8a2f235558105940c39b1033556d9f9.tar.bz2
sord-c816ee27e8a2f235558105940c39b1033556d9f9.zip
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/sord/trunk@300 3d64ff67-21c5-427c-a301-fe4f08042e5a
-rw-r--r--sord/sord.h4
-rw-r--r--src/zix/hash.h20
2 files changed, 12 insertions, 12 deletions
diff --git a/sord/sord.h b/sord/sord.h
index 2269d13..93418db 100644
--- a/sord/sord.h
+++ b/sord/sord.h
@@ -159,7 +159,7 @@ sord_world_free(SordWorld* world);
/**
Set a function to be called when errors occur.
- The @p error_sink will be called with @p handle as its first argument. If
+ The `error_sink` will be called with `handle` as its first argument. If
no error function is set, errors are printed to stderr.
*/
SORD_API
@@ -399,7 +399,7 @@ sord_search(SordModel* model,
const SordNode* g);
/**
Search for a single node that matches a pattern.
- Exactly one of @p s, @p p, @p o must be NULL.
+ Exactly one of `s`, `p`, `o` must be NULL.
This function is mainly useful for predicates that only have one value.
The returned node must be freed using sord_node_free.
@return the first matching node, or NULL if no matches are found.
diff --git a/src/zix/hash.h b/src/zix/hash.h
index 5b265ff..e6f4028 100644
--- a/src/zix/hash.h
+++ b/src/zix/hash.h
@@ -65,29 +65,29 @@ zix_hash_new(ZixHashFunc hash_func,
size_t value_size);
/**
- Free @p hash.
+ Free `hash`.
*/
ZIX_API void
zix_hash_free(ZixHash* hash);
/**
- Return the number of elements in @p hash.
+ Return the number of elements in `hash`.
*/
ZIX_API size_t
zix_hash_size(const ZixHash* hash);
/**
- Insert an item into @p hash.
+ Insert an item into `hash`.
If no matching value is found, ZIX_STATUS_SUCCESS will be returned, and @p
- inserted will be pointed to the copy of @p value made in the new hash node.
+ inserted will be pointed to the copy of `value` made in the new hash node.
If a matching value already exists, ZIX_STATUS_EXISTS will be returned, and
- @p inserted will be pointed to the existing value.
+ `inserted` will be pointed to the existing value.
@param hash The hash table.
@param value The value to be inserted.
- @param inserted The copy of @p value in the hash table.
+ @param inserted The copy of `value` in the hash table.
@return ZIX_STATUS_SUCCESS, ZIX_STATUS_EXISTS, or ZIX_STATUS_NO_MEM.
*/
ZIX_API ZixStatus
@@ -96,7 +96,7 @@ zix_hash_insert(ZixHash* hash,
const void** inserted);
/**
- Remove an item from @p hash.
+ Remove an item from `hash`.
@param hash The hash table.
@param value The value to remove.
@@ -107,7 +107,7 @@ zix_hash_remove(ZixHash* hash,
const void* value);
/**
- Search for an item in @p hash.
+ Search for an item in `hash`.
@param hash The hash table.
@param value The value to search for.
@@ -117,11 +117,11 @@ zix_hash_find(const ZixHash* hash,
const void* value);
/**
- Call @p f on each value in @p hash.
+ Call `f` on each value in `hash`.
@param hash The hash table.
@param f The function to call on each value.
- @param user_data The user_data parameter passed to @p f.
+ @param user_data The user_data parameter passed to `f`.
*/
ZIX_API void
zix_hash_foreach(ZixHash* hash,