diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/sord.c | 10 | ||||
| -rw-r--r-- | src/zix/tree.c | 10 | ||||
| -rw-r--r-- | src/zix/tree.h | 32 |
3 files changed, 26 insertions, 26 deletions
@@ -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, diff --git a/src/zix/tree.c b/src/zix/tree.c index 844adb9..23a7e8c 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 f89d9e5..8474b1c 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(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(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(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); |