summaryrefslogtreecommitdiffstats
path: root/src/sord.c
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 14:46:21 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 14:46:21 +0000
commitc39c5ec4f603605c29b3cfca405f9c121ac8ddde (patch)
tree6d3e83c0b67dbc33382803f30621ab98599ff7e4 /src/sord.c
parentc816ee27e8a2f235558105940c39b1033556d9f9 (diff)
downloadsord-c39c5ec4f603605c29b3cfca405f9c121ac8ddde.tar.gz
sord-c39c5ec4f603605c29b3cfca405f9c121ac8ddde.tar.bz2
sord-c39c5ec4f603605c29b3cfca405f9c121ac8ddde.zip
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/sord/trunk@301 3d64ff67-21c5-427c-a301-fe4f08042e5a
Diffstat (limited to 'src/sord.c')
-rw-r--r--src/sord.c10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/sord.c b/src/sord.c
index 68f3053..cdfef62 100644
--- a/src/sord.c
+++ b/src/sord.c
@@ -336,7 +336,7 @@ sord_iter_forward(SordIter* iter)
}
/**
- Seek forward as necessary until @a iter points at a match.
+ Seek forward as necessary until `iter` points at a match.
@return true iff iterator reached end of valid range.
*/
static inline bool
@@ -353,7 +353,7 @@ sord_iter_seek_match(SordIter* iter)
}
/**
- Seek forward as necessary until @a iter points at a match, or the prefix
+ Seek forward as necessary until `iter` points at a match, or the prefix
no longer matches iter->pat.
@return true iff iterator reached end of valid range.
*/
@@ -520,8 +520,8 @@ sord_iter_free(SordIter* iter)
}
/**
- Return true iff @a sord has an index for @a order.
- If @a graphs is true, @a order will be modified to be the
+ Return true iff `sord` has an index for `order`.
+ If `graphs` is true, `order` will be modified to be the
corresponding order with a G prepended (so G will be the MSN).
*/
static inline bool
@@ -540,7 +540,7 @@ sord_has_index(SordModel* sord, SordOrder* order, int* n_prefix, bool graphs)
@param pat Pattern in standard (S P O G) order
@param mode Set to the (best) iteration mode for iterating over results
@param n_prefix Set to the length of the range prefix
- (for @a mode == RANGE and @a mode == FILTER_RANGE)
+ (for `mode` == RANGE and `mode` == FILTER_RANGE)
*/
static inline SordOrder
sord_best_index(SordModel* sord,