diff options
| -rw-r--r-- | sord/sord.h | 54 | ||||
| -rw-r--r-- | src/sord.c | 10 | ||||
| -rw-r--r-- | src/zix/tree.c | 10 | ||||
| -rw-r--r-- | src/zix/tree.h | 32 |
4 files changed, 53 insertions, 53 deletions
diff --git a/sord/sord.h b/sord/sord.h index 93418db..5ff9a7b 100644 --- a/sord/sord.h +++ b/sord/sord.h @@ -150,7 +150,7 @@ SordWorld* sord_world_new(void); /** - Free @c world. + Free `world`. */ SORD_API void @@ -177,8 +177,8 @@ sord_world_set_error_sink(SordWorld* world, /** Get a URI node from a string. - Note this function measures @c str, which is a common bottleneck. - Use sord_node_from_serd_node instead if @c str is already measured. + Note this function measures `str`, which is a common bottleneck. + Use sord_node_from_serd_node instead if `str` is already measured. */ SORD_API SordNode* @@ -196,8 +196,8 @@ sord_new_relative_uri(SordWorld* world, /** Get a blank node from a string. - Note this function measures @c str, which is a common bottleneck. - Use sord_node_from_serd_node instead if @c str is already measured. + Note this function measures `str`, which is a common bottleneck. + Use sord_node_from_serd_node instead if `str` is already measured. */ SORD_API SordNode* @@ -206,8 +206,8 @@ sord_new_blank(SordWorld* world, const uint8_t* str); /** Get a literal node from a string. - Note this function measures @c str, which is a common bottleneck. - Use sord_node_from_serd_node instead if @c str is already measured. + Note this function measures `str`, which is a common bottleneck. + Use sord_node_from_serd_node instead if `str` is already measured. */ SORD_API SordNode* @@ -220,7 +220,7 @@ sord_new_literal(SordWorld* world, Copy a node (obtain a reference). Node that since nodes are interned and reference counted, this does not - actually create a deep copy of @c node. + actually create a deep copy of `node`. */ SORD_API SordNode* @@ -248,7 +248,7 @@ const uint8_t* sord_node_get_string(const SordNode* node); /** - Return the string value of a node, and set @c len to its length. + Return the string value of a node, and set `len` to its length. */ SORD_API const uint8_t* @@ -287,7 +287,7 @@ bool sord_node_is_inline_object(const SordNode* node); /** - Return true iff @c a is equal to @c b. + Return true iff `a` is equal to `b`. Note this is much faster than comparing the node's strings. */ @@ -342,37 +342,37 @@ sord_new(SordWorld* world, bool graphs); /** - Close and free @c model. + Close and free `model`. */ SORD_API void sord_free(SordModel* model); /** - Get the world associated with @c model. + Get the world associated with `model`. */ SORD_API SordWorld* sord_get_world(SordModel* model); /** - Return the number of nodes stored in @c world. + Return the number of nodes stored in `world`. - Nodes are included in this count iff they are a part of a quad in @c world. + Nodes are included in this count iff they are a part of a quad in `world`. */ SORD_API size_t sord_num_nodes(const SordWorld* world); /** - Return the number of quads stored in @c model. + Return the number of quads stored in `model`. */ SORD_API size_t sord_num_quads(const SordModel* model); /** - Return an iterator to the start of @c model. + Return an iterator to the start of `model`. */ SORD_API SordIter* @@ -435,7 +435,7 @@ sord_count(SordModel* model, const SordNode* g); /** - Check if @a model contains a triple pattern. + Check if `model` contains a triple pattern. */ SORD_API bool @@ -451,7 +451,7 @@ sord_add(SordModel* model, const SordQuad quad); /** Remove a quad from a model. - Note that is it illegal to remove while iterating over @c model. + Note that is it illegal to remove while iterating over `model`. */ SORD_API void @@ -522,42 +522,42 @@ sord_inserter_write_statement(SordInserter* inserter, */ /** - Set @c quad to the quad pointed to by @c iter. + Set `quad` to the quad pointed to by `iter`. */ SORD_API void sord_iter_get(const SordIter* iter, SordQuad quad); /** - Return a field of the quad pointed to by @c iter. + Return a field of the quad pointed to by `iter`. */ SORD_API const SordNode* sord_iter_get_node(const SordIter* iter, SordQuadIndex index); /** - Return the store pointed to by @c iter. + Return the store pointed to by `iter`. */ SORD_API const SordModel* sord_iter_get_model(SordIter* iter); /** - Increment @c iter to point to the next statement. + Increment `iter` to point to the next statement. */ SORD_API bool sord_iter_next(SordIter* iter); /** - Return true iff @c iter is at the end of its range. + Return true iff `iter` is at the end of its range. */ SORD_API bool sord_iter_end(const SordIter* iter); /** - Free @c iter. + Free `iter`. */ SORD_API void @@ -574,7 +574,7 @@ sord_iter_free(SordIter* iter); This function is a straightforward and fast equivalence match with wildcard support (ID 0 is a wildcard). It does not actually read node data. - @return true iff @c x and @c y match. + @return true iff `x` and `y` match. */ SORD_API bool @@ -587,7 +587,7 @@ sord_quad_match(const SordQuad x, const SordQuad y); */ /** - Return a reader that will read into @c model. + Return a reader that will read into `model`. */ SORD_API SerdReader* @@ -608,7 +608,7 @@ sord_write(SordModel* model, /** Write a range to a writer. - This increments @c iter to its end, then frees it. + This increments `iter` to its end, then frees it. */ SORD_API bool @@ -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); |