Convert <code> markup to Markdown
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/52eed70d Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/52eed70d Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/52eed70d Branch: refs/heads/markdown Commit: 52eed70dba006da87a3e5c4ff26add5cbb09c74b Parents: fca91dc Author: Nick Wellnhofer <[email protected]> Authored: Mon Nov 10 00:35:06 2014 +0100 Committer: Nick Wellnhofer <[email protected]> Committed: Sun Nov 23 18:35:49 2014 +0100 ---------------------------------------------------------------------- compiler/src/CFCBindCore.h | 2 +- compiler/src/CFCMethod.h | 2 +- compiler/src/CFCParcel.h | 2 +- compiler/src/CFCPerlPod.c | 2 +- compiler/src/CFCPerlPod.h | 2 +- compiler/src/CFCSymbol.h | 6 +-- compiler/src/CFCType.h | 10 ++-- compiler/src/CFCUtil.h | 4 +- compiler/src/CFCVariable.h | 2 +- runtime/core/Clownfish/ByteBuf.cfh | 4 +- runtime/core/Clownfish/CharBuf.cfh | 10 ++-- runtime/core/Clownfish/Err.cfh | 12 ++--- runtime/core/Clownfish/Hash.cfh | 8 ++-- runtime/core/Clownfish/Obj.cfh | 16 +++---- runtime/core/Clownfish/String.cfh | 14 +++--- .../core/Clownfish/TestHarness/TestUtils.cfh | 12 ++--- runtime/core/Clownfish/Util/Atomic.cfh | 6 +-- runtime/core/Clownfish/Util/NumberUtils.cfh | 50 ++++++++++---------- runtime/core/Clownfish/Util/SortUtils.cfh | 2 +- runtime/core/Clownfish/Util/StringHelper.cfh | 2 +- runtime/core/Clownfish/VArray.cfh | 16 +++---- runtime/perl/xs/XSBind.h | 4 +- 22 files changed, 94 insertions(+), 94 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCBindCore.h ---------------------------------------------------------------------- diff --git a/compiler/src/CFCBindCore.h b/compiler/src/CFCBindCore.h index 33fdd82..f6389d7 100644 --- a/compiler/src/CFCBindCore.h +++ b/compiler/src/CFCBindCore.h @@ -50,7 +50,7 @@ CFCBindCore_init(CFCBindCore *self, struct CFCHierarchy *hierarchy, void CFCBindCore_destroy(CFCBindCore *self); -/** Call <code>CFCHierarchy_propagate_modified</code>to establish which +/** Call `CFCHierarchy_propagate_modified`to establish which * classes do not have up-to-date generated .c and .h files, then traverse the * hierarchy writing all necessary files. */ http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCMethod.h ---------------------------------------------------------------------- diff --git a/compiler/src/CFCMethod.h b/compiler/src/CFCMethod.h index f6beb94..9baea2b 100644 --- a/compiler/src/CFCMethod.h +++ b/compiler/src/CFCMethod.h @@ -185,7 +185,7 @@ CFCMethod_abstract(CFCMethod *self); int CFCMethod_novel(CFCMethod *self); -/** Return the Clownfish::CFC::Model::Type for <code>self</code>. +/** Return the Clownfish::CFC::Model::Type for `self`. */ struct CFCType* http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCParcel.h ---------------------------------------------------------------------- diff --git a/compiler/src/CFCParcel.h b/compiler/src/CFCParcel.h index 9bd37be..dff7deb 100644 --- a/compiler/src/CFCParcel.h +++ b/compiler/src/CFCParcel.h @@ -41,7 +41,7 @@ typedef struct CFCPrereq CFCPrereq; struct CFCFileSpec; struct CFCVersion; -/** Return the parcel which has been registered for <code>name</code>. +/** Return the parcel which has been registered for `name`. */ CFCParcel* CFCParcel_fetch(const char *name); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCPerlPod.c ---------------------------------------------------------------------- diff --git a/compiler/src/CFCPerlPod.c b/compiler/src/CFCPerlPod.c index 78c804f..b864fcb 100644 --- a/compiler/src/CFCPerlPod.c +++ b/compiler/src/CFCPerlPod.c @@ -348,7 +348,7 @@ char* CFCPerlPod_perlify_doc_text(CFCPerlPod *self, const char *source) { (void)self; // unused - // Change <code>foo</code> to C<< foo >>. + // Change `foo` to C<< foo >>. char *copy = CFCUtil_strdup(source); char *orig = copy; copy = S_global_replace(orig, "<code>", "C<< "); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCPerlPod.h ---------------------------------------------------------------------- diff --git a/compiler/src/CFCPerlPod.h b/compiler/src/CFCPerlPod.h index 3fb94eb..38bb0c1 100644 --- a/compiler/src/CFCPerlPod.h +++ b/compiler/src/CFCPerlPod.h @@ -43,7 +43,7 @@ CFCPerlPod_destroy(CFCPerlPod *self); * Perl-space. * @param method The name of the method from the Clownfish class. If not * supplied, an attempt will be made to locate the correct method using - * <code>alias</code>. + * `alias`. * @param sample An optional Perl usage sample. * @param pod Optional verbatim POD, which will override all POD which would * otherwise have been generated. http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCSymbol.h ---------------------------------------------------------------------- diff --git a/compiler/src/CFCSymbol.h b/compiler/src/CFCSymbol.h index 2fecf48..98cdc83 100644 --- a/compiler/src/CFCSymbol.h +++ b/compiler/src/CFCSymbol.h @@ -135,17 +135,17 @@ CFCSymbol_short_sym(CFCSymbol *self); const char* CFCSymbol_full_sym(CFCSymbol *self); -/** Get the Symbol's all-lowercase prefix, delegating to <code>parcel</code>. +/** Get the Symbol's all-lowercase prefix, delegating to `parcel`. */ const char* CFCSymbol_get_prefix(CFCSymbol *self); -/** Get the Symbol's Titlecase prefix, delegating to <code>parcel</code>. +/** Get the Symbol's Titlecase prefix, delegating to `parcel`. */ const char* CFCSymbol_get_Prefix(CFCSymbol *self); -/** Get the Symbol's all-uppercase prefix, delegating to <code>parcel</code>. +/** Get the Symbol's all-uppercase prefix, delegating to `parcel`. */ const char* CFCSymbol_get_PREFIX(CFCSymbol *self); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCType.h ---------------------------------------------------------------------- diff --git a/compiler/src/CFCType.h b/compiler/src/CFCType.h index dddab6a..f351eba 100644 --- a/compiler/src/CFCType.h +++ b/compiler/src/CFCType.h @@ -98,7 +98,7 @@ CFCType_new_float(int flags, const char *specifier); /** Create a Type representing an object. * - * The supplied <code>specifier</code> must match the last component of the + * The supplied `specifier` must match the last component of the * class name -- i.e. for the class "Crustacean::Lobster" it must be * "Lobster". * @@ -131,10 +131,10 @@ CFCType_new_composite(int flags, CFCType *child, int indirection, /** Return a Clownfish::CFC::Model::Type representing a the 'void' keyword in * C. It can be used either for a void return type, or in conjuction with - * with new_composite() to support the <code>void*</code> opaque pointer type. + * with new_composite() to support the `void*` opaque pointer type. * * @param is_const Should be true if the type is const. (Useful in the - * context of <code>const void*</code>). + * context of `const void*`). */ CFCType* CFCType_new_void(int is_const); @@ -148,7 +148,7 @@ CFCType_new_va_list(void); * with complex declaration syntaxes -- such as unions, structs, enums, or * function pointers -- from within Clownfish itself. * - * The only constraint is that the <code>specifier</code> must end in "_t". + * The only constraint is that the `specifier` must end in "_t". * This allows us to create complex types in a C header file... * * typedef union { float f; int i; } floatint_t; @@ -158,7 +158,7 @@ CFCType_new_va_list(void); * * floatint_t floatint; * - * If <code>parcel</code> is supplied and <code>specifier</code> begins with a + * If `parcel` is supplied and `specifier` begins with a * capital letter, the Parcel's prefix will be prepended to the specifier: * * foo_t -> foo_t # no prefix prepending http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCUtil.h ---------------------------------------------------------------------- diff --git a/compiler/src/CFCUtil.h b/compiler/src/CFCUtil.h index 6540672..295006e 100644 --- a/compiler/src/CFCUtil.h +++ b/compiler/src/CFCUtil.h @@ -138,8 +138,8 @@ CFCUtil_current(const char *orig, const char *dest); void CFCUtil_write_file(const char *filename, const char *content, size_t len); -/** Test whether there's a file at <code>path</code> which already matches - * <code>content</code> exactly. If something has changed, write the file. +/** Test whether there's a file at `path` which already matches + * `content` exactly. If something has changed, write the file. * Otherwise do nothing (and avoid bumping the file's modification time). * * @return true if the file was written, false otherwise. http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/compiler/src/CFCVariable.h ---------------------------------------------------------------------- diff --git a/compiler/src/CFCVariable.h b/compiler/src/CFCVariable.h index a7c0c23..671bf67 100644 --- a/compiler/src/CFCVariable.h +++ b/compiler/src/CFCVariable.h @@ -73,7 +73,7 @@ CFCVariable_inert(CFCVariable *self); /** Returns a string with the Variable's C type and its - * <code>micro_sym</code>. For instance: + * `micro_sym`. For instance: * * int32_t average_lifespan */ http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/ByteBuf.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/ByteBuf.cfh b/runtime/core/Clownfish/ByteBuf.cfh index 065b1d7..01869e7 100644 --- a/runtime/core/Clownfish/ByteBuf.cfh +++ b/runtime/core/Clownfish/ByteBuf.cfh @@ -92,14 +92,14 @@ class Clownfish::ByteBuf nickname BB inherits Clownfish::Obj { void Cat_Bytes(ByteBuf *self, const void *bytes, size_t size); - /** Concatenate the contents of <code>other</code> onto the end of the + /** Concatenate the contents of `other` onto the end of the * original ByteBuf. Allocate more memory as needed. */ void Cat(ByteBuf *self, ByteBuf *other); /** Assign more memory to the ByteBuf, if it doesn't already have enough - * room to hold <code>size</code> bytes. Cannot shrink the allocation. + * room to hold `size` bytes. Cannot shrink the allocation. * * @return a pointer to the raw buffer. */ http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/CharBuf.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/CharBuf.cfh b/runtime/core/Clownfish/CharBuf.cfh index c3c3272..0b1657f 100644 --- a/runtime/core/Clownfish/CharBuf.cfh +++ b/runtime/core/Clownfish/CharBuf.cfh @@ -53,7 +53,7 @@ class Clownfish::CharBuf nickname CB /** Return a pointer to a new CharBuf which contains formatted data * expanded according to CB_VCatF. * - * Note: a user-supplied <code>pattern</code> string is a security hole + * Note: a user-supplied `pattern` string is a security hole * and must not be allowed. */ inert incremented CharBuf* @@ -76,7 +76,7 @@ class Clownfish::CharBuf nickname CB void Cat_Trusted_Utf8(CharBuf *self, const char *ptr, size_t size); - /** Concatenate the contents of <code>string</code> onto the end of the + /** Concatenate the contents of `string` onto the end of the * caller. */ void @@ -109,7 +109,7 @@ class Clownfish::CharBuf nickname CB Cat_Char(CharBuf *self, int32_t code_point); /** Assign more memory to the CharBuf, if it doesn't already have enough - * room to hold a string of <code>size</code> bytes. Cannot shrink the + * room to hold a string of `size` bytes. Cannot shrink the * allocation. * * @return a pointer to the raw buffer. @@ -117,12 +117,12 @@ class Clownfish::CharBuf nickname CB char* Grow(CharBuf *self, size_t size); - /** Set the CharBuf's <code>size</code> attribute. + /** Set the CharBuf's `size` attribute. */ void Set_Size(CharBuf *self, size_t size); - /** Get the CharBuf's <code>size</code> attribute. + /** Get the CharBuf's `size` attribute. */ size_t Get_Size(CharBuf *self); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/Err.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Err.cfh b/runtime/core/Clownfish/Err.cfh index 155b649..60f6ecb 100644 --- a/runtime/core/Clownfish/Err.cfh +++ b/runtime/core/Clownfish/Err.cfh @@ -66,7 +66,7 @@ public class Clownfish::Err inherits Clownfish::Obj { public String* Get_Mess(Err *self); - /** Add information about the current stack frame onto <code>mess</code>. + /** Add information about the current stack frame onto `mess`. */ void Add_Frame(Err *self, const char *file, int line, const char *func); @@ -81,7 +81,7 @@ public class Clownfish::Err inherits Clownfish::Obj { public inert nullable Err* get_error(); - /** Run <code>routine</code> within the host's exception handling + /** Run `routine` within the host's exception handling * environment, catching and returning any errors that occur. * * If an unrecognized host exception is trapped, it will be wrapped in an @@ -139,8 +139,8 @@ public class Clownfish::Err inherits Clownfish::Obj { make_mess(const char *file, int line, const char *func, const char *pattern, ...); - /** Verify that <code>obj</code> is either NULL or inherits from - * <code>klass</code>. + /** Verify that `obj` is either NULL or inherits from + * `klass`. * * @return the object. */ @@ -148,8 +148,8 @@ public class Clownfish::Err inherits Clownfish::Obj { downcast(Obj *obj, Class *klass, const char *file, int line, const char *func); - /** Verify that <code>obj</code> is not NULL and inherits from - * <code>klass</code>. + /** Verify that `obj` is not NULL and inherits from + * `klass`. * * @return the object. */ http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/Hash.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Hash.cfh b/runtime/core/Clownfish/Hash.cfh index 6cd5ff1..abc3f38 100644 --- a/runtime/core/Clownfish/Hash.cfh +++ b/runtime/core/Clownfish/Hash.cfh @@ -53,7 +53,7 @@ class Clownfish::Hash inherits Clownfish::Obj { void Clear(Hash *self); - /** Store a key-value pair. If <code>key</code> is not already present, + /** Store a key-value pair. If `key` is not already present, * Make_Key() will be called to manufacture the internally used key. */ void @@ -63,9 +63,9 @@ class Clownfish::Hash inherits Clownfish::Obj { Store_Utf8(Hash *self, const char *str, size_t len, decremented Obj *value); - /** Fetch the value associated with <code>key</code>. + /** Fetch the value associated with `key`. * - * @return the value, or NULL if <code>key</code> is not present. + * @return the value, or NULL if `key` is not present. */ nullable Obj* Fetch(Hash *self, Obj *key); @@ -75,7 +75,7 @@ class Clownfish::Hash inherits Clownfish::Obj { /** Attempt to delete a key-value pair from the hash. * - * @return the value if <code>key</code> exists and thus deletion + * @return the value if `key` exists and thus deletion * succeeds; otherwise NULL. */ incremented nullable Obj* http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/Obj.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Obj.cfh b/runtime/core/Clownfish/Obj.cfh index 91e981d..d3c9f59 100644 --- a/runtime/core/Clownfish/Obj.cfh +++ b/runtime/core/Clownfish/Obj.cfh @@ -42,7 +42,7 @@ public class Clownfish::Obj { /** NULL-safe invocation of Inc_RefCount(). * - * @return NULL if <code>self</code> is NULL, otherwise the return value + * @return NULL if `self` is NULL, otherwise the return value * of Inc_RefCount(). */ inert inline incremented Obj* @@ -57,7 +57,7 @@ public class Clownfish::Obj { /** NULL-safe invocation of Dec_RefCount(). * - * @return NULL if <code>self</code> is NULL, otherwise the return value + * @return NULL if `self` is NULL, otherwise the return value * of Dec_RefCount(). */ inert inline uint32_t @@ -79,8 +79,8 @@ public class Clownfish::Obj { public void Destroy(Obj *self); - /** Invoke the Destroy() method found in <code>klass</code> on - * <code>self</code>. + /** Invoke the Destroy() method found in `klass` on + * `self`. * * TODO: Eliminate this function if we can arrive at a proper SUPER syntax. */ @@ -100,8 +100,8 @@ public class Clownfish::Obj { * * @param other Another Obj. * @return 0 if the objects are equal, a negative number if - * <code>self</code> is less than <code>other</code>, and a positive - * number if <code>self</code> is greater than <code>other</code>. + * `self` is less than `other`, and a positive + * number if `self` is greater than `other`. */ public abstract int32_t Compare_To(Obj *self, Obj *other); @@ -121,7 +121,7 @@ public class Clownfish::Obj { public String* Get_Class_Name(Obj *self); - /** Indicate whether the object is a descendent of <code>ancestor</code>. + /** Indicate whether the object is a descendent of `ancestor`. */ public bool Is_A(Obj *self, Class *ancestor); @@ -148,7 +148,7 @@ public class Clownfish::Obj { To_Bool(Obj *self); /** Update the internal state of the object to mimic that of - * <code>other</code>. + * `other`. */ public abstract void Mimic(Obj *self, Obj *other); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/String.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/String.cfh b/runtime/core/Clownfish/String.cfh index 383f6b7..32f37a7 100644 --- a/runtime/core/Clownfish/String.cfh +++ b/runtime/core/Clownfish/String.cfh @@ -91,7 +91,7 @@ class Clownfish::String nickname Str /** Return a pointer to a new String which contains formatted data * expanded according to CB_VCatF. * - * Note: a user-supplied <code>pattern</code> string is a security hole + * Note: a user-supplied `pattern` string is a security hole * and must not be allowed. */ inert incremented String* @@ -104,13 +104,13 @@ class Clownfish::String nickname Str compare(const void *va, const void *vb); /** Perform lexical comparison of two Strings, with level of indirection - * set to please qsort and friends, and return true if <code>a</code> is - * less than <code>b</code>. + * set to please qsort and friends, and return true if `a` is + * less than `b`. */ inert bool less_than(const void *va, const void *vb); - /** Return the concatenation of the String and <code>other</code>. + /** Return the concatenation of the String and `other`. */ incremented String* Cat(String *self, String *other); @@ -183,7 +183,7 @@ class Clownfish::String nickname Str size_t Length(String *self); - /** Get the String's <code>size</code> attribute. + /** Get the String's `size` attribute. */ size_t Get_Size(String *self); @@ -388,7 +388,7 @@ class Clownfish::StringIterator nickname StrIter Skip_Prev_Whitespace(StringIterator *self); /** Test whether the content after the iterator starts with - * <code>prefix</code>. + * `prefix`. */ bool Starts_With(StringIterator *self, String *prefix); @@ -400,7 +400,7 @@ class Clownfish::StringIterator nickname StrIter Starts_With_Utf8(StringIterator *self, const char *prefix, size_t size); /** Test whether the content before the iterator ends with - * <code>postfix</code>. + * `postfix`. */ bool Ends_With(StringIterator *self, String *postfix); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/TestHarness/TestUtils.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/TestHarness/TestUtils.cfh b/runtime/core/Clownfish/TestHarness/TestUtils.cfh index 90a9e36..4107189 100644 --- a/runtime/core/Clownfish/TestHarness/TestUtils.cfh +++ b/runtime/core/Clownfish/TestHarness/TestUtils.cfh @@ -28,28 +28,28 @@ inert class Clownfish::TestHarness::TestUtils { inert uint64_t random_u64(); - /** Return an array of <code>count</code> random 64-bit integers where + /** Return an array of `count` random 64-bit integers where * <code>min <= n < limit</code>. * - * If <code>buf</code> is NULL, it will be allocated, otherwise it will + * If `buf` is NULL, it will be allocated, otherwise it will * be used. */ inert int64_t* random_i64s(int64_t *buf, size_t count, int64_t min, int64_t limit); - /** Return an array of <code>count</code> random unsigned, 64-bit integers + /** Return an array of `count` random unsigned, 64-bit integers * where <code>min <= n < limit</code>. * - * If <code>buf</code> is NULL, it will be allocated, otherwise it will + * If `buf` is NULL, it will be allocated, otherwise it will * be used. */ inert uint64_t* random_u64s(uint64_t *buf, size_t count, uint64_t min, uint64_t limit); - /** Return an array of <code>count</code> random double-precision floating + /** Return an array of `count` random double-precision floating * point numbers between 0 and 1. * - * If <code>buf</code> is NULL, it will be allocated, otherwise it will + * If `buf` is NULL, it will be allocated, otherwise it will * be used. */ inert double* http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/Util/Atomic.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Util/Atomic.cfh b/runtime/core/Clownfish/Util/Atomic.cfh index fac9b40..7a950a7 100644 --- a/runtime/core/Clownfish/Util/Atomic.cfh +++ b/runtime/core/Clownfish/Util/Atomic.cfh @@ -22,9 +22,9 @@ inert class Clownfish::Util::Atomic { } __C__ -/** Compare and swap a pointer. Test whether the value at <code>target</code> - * matches <code>old_value</code>. If it does, set <code>target</code> to - * <code>new_value</code> and return true. Otherwise, return false. +/** Compare and swap a pointer. Test whether the value at `target` + * matches `old_value`. If it does, set `target` to + * `new_value` and return true. Otherwise, return false. */ static CFISH_INLINE bool cfish_Atomic_cas_ptr(void *volatile *target, void *old_value, void *new_value); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/Util/NumberUtils.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Util/NumberUtils.cfh b/runtime/core/Clownfish/Util/NumberUtils.cfh index 565359d..efab6cb 100644 --- a/runtime/core/Clownfish/Util/NumberUtils.cfh +++ b/runtime/core/Clownfish/Util/NumberUtils.cfh @@ -86,91 +86,91 @@ inert class Clownfish::Util::NumberUtils nickname NumUtil { inert inline double decode_bigend_f64(const void *source); - /** Encode a C32 at the space pointed to by <code>dest</code>. As a side - * effect, <code>dest</code> will be advanced to immediately after the end + /** Encode a C32 at the space pointed to by `dest`. As a side + * effect, `dest` will be advanced to immediately after the end * of the C32. */ inert inline void encode_c32(uint32_t value, char **dest); - /** Encode a C32 at the space pointed to by <code>dest</code>, but add + /** Encode a C32 at the space pointed to by `dest`, but add * "leading zeroes" so that the space consumed will always be 5 bytes. As - * a side effect, <code>dest</code> will be advanced to immediately after + * a side effect, `dest` will be advanced to immediately after * the end of the C32. */ inert inline void encode_padded_c32(uint32_t value, char **dest); - /** Encode a C64 at the space pointed to by <code>dest</code>. As a side - * effect, <code>dest</code> will be advanced to immediately after the end + /** Encode a C64 at the space pointed to by `dest`. As a side + * effect, `dest` will be advanced to immediately after the end * of the C64. */ inert inline void encode_c64(uint64_t value, char **dest); - /** Read a C32 from the buffer pointed to by <code>source</code>. As a + /** Read a C32 from the buffer pointed to by `source`. As a * side effect, advance the pointer, consuming the bytes occupied by the * C32. */ inert inline uint32_t decode_c32(const char **source); - /** Read a C64 from the buffer pointed to by <code>source</code>. As a + /** Read a C64 from the buffer pointed to by `source`. As a * side effect, advance the pointer, consuming the bytes occupied by the * C64. */ inert inline uint64_t decode_c64(const char **source); - /** Advance <code>source</code> past one encoded C32 or C64. + /** Advance `source` past one encoded C32 or C64. */ inert inline void skip_cint(const char **source); - /** Interpret <code>array</code> as an array of bits; return true if the - * bit at <code>tick</code> is set, false otherwise. + /** Interpret `array` as an array of bits; return true if the + * bit at `tick` is set, false otherwise. */ inert inline bool u1get(const void *array, uint32_t tick); - /** Interpret <code>array</code> as an array of bits; set the bit at - * <code>tick</code>. + /** Interpret `array` as an array of bits; set the bit at + * `tick`. */ inert inline void u1set(void *array, uint32_t tick); - /** Interpret <code>array</code> as an array of bits; clear the bit at - * <code>tick</code>. + /** Interpret `array` as an array of bits; clear the bit at + * `tick`. */ inert inline void u1clear(void *array, uint32_t tick); - /** Interpret <code>array</code> as an array of bits; flip the bit at - * <code>tick</code>. + /** Interpret `array` as an array of bits; flip the bit at + * `tick`. */ inert inline void u1flip(void *array, uint32_t tick); - /** Interpret <code>array</code> as an array of two-bit integers; return - * the value at <code>tick</code>. + /** Interpret `array` as an array of two-bit integers; return + * the value at `tick`. */ inert inline uint8_t u2get(const void *array, uint32_t tick); - /** Interpret <code>array</code> as an array of two-bit integers; set the - * element at <code>tick</code> to <code>value</code>. + /** Interpret `array` as an array of two-bit integers; set the + * element at `tick` to `value`. */ inert inline void u2set(void *array, uint32_t tick, uint8_t value); - /** Interpret <code>array</code> as an array of four-bit integers; return - * the value at <code>tick</code>. + /** Interpret `array` as an array of four-bit integers; return + * the value at `tick`. */ inert inline uint8_t u4get(const void *array, uint32_t tick); - /** Interpret <code>array</code> as an array of four-bit integers; set the - * element at <code>tick</code> to <code>value</code>. + /** Interpret `array` as an array of four-bit integers; set the + * element at `tick` to `value`. */ inert inline void u4set(void *array, uint32_t tick, uint8_t value); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/Util/SortUtils.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Util/SortUtils.cfh b/runtime/core/Clownfish/Util/SortUtils.cfh index f402f2d..8525ebe 100644 --- a/runtime/core/Clownfish/Util/SortUtils.cfh +++ b/runtime/core/Clownfish/Util/SortUtils.cfh @@ -41,7 +41,7 @@ inert class Clownfish::Util::SortUtils nickname Sort { CFISH_Sort_Compare_t compare, void *context); /** Merge two source arrays together using the classic mergesort merge - * algorithm, storing the result in <code>dest</code>. + * algorithm, storing the result in `dest`. * * Most merge functions operate on a single contiguous array and copy the * merged results results back into the source array before returning. http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/Util/StringHelper.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Util/StringHelper.cfh b/runtime/core/Clownfish/Util/StringHelper.cfh index 52f5816..6595bcc 100644 --- a/runtime/core/Clownfish/Util/StringHelper.cfh +++ b/runtime/core/Clownfish/Util/StringHelper.cfh @@ -29,7 +29,7 @@ inert class Clownfish::Util::StringHelper nickname StrHelp { overlap(const char *a, const char *b, size_t a_len, size_t b_len); /** Encode a NULL-terminated string representation of a value in base 36 - * into <code>buffer</code>. + * into `buffer`. * * @param value The number to be encoded. * @param buffer A buffer at least MAX_BASE36_BYTES bytes long. http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/core/Clownfish/VArray.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/VArray.cfh b/runtime/core/Clownfish/VArray.cfh index b5cb20a..69cc71e 100644 --- a/runtime/core/Clownfish/VArray.cfh +++ b/runtime/core/Clownfish/VArray.cfh @@ -70,7 +70,7 @@ class Clownfish::VArray nickname VA inherits Clownfish::Obj { incremented nullable Obj* Shift(VArray *self); - /** Ensure that the VArray has room for at least <code>capacity</code> + /** Ensure that the VArray has room for at least `capacity` * elements. */ void @@ -81,7 +81,7 @@ class Clownfish::VArray nickname VA inherits Clownfish::Obj { nullable Obj* Fetch(VArray *self, uint32_t tick); - /** Store an element at index <code>tick</code>, possibly displacing an + /** Store an element at index `tick`, possibly displacing an * existing element. */ void @@ -89,13 +89,13 @@ class Clownfish::VArray nickname VA inherits Clownfish::Obj { /** Replace an element in the VArray with NULL and return it. * - * @return whatever was stored at <code>tick</code>. + * @return whatever was stored at `tick`. */ incremented nullable Obj* Delete(VArray *self, uint32_t tick); - /** Remove <code>length</code> elements from the array, starting at - * <code>offset</code>. Move elements over to fill in the gap. + /** Remove `length` elements from the array, starting at + * `offset`. Move elements over to fill in the gap. */ void Excise(VArray *self, uint32_t offset, uint32_t length); @@ -134,17 +134,17 @@ class Clownfish::VArray nickname VA inherits Clownfish::Obj { void Clear(VArray *self); - /** Accessor for <code>size</code> member. + /** Accessor for `size` member. */ public uint32_t Get_Size(VArray *self); - /** Accessor for <code>capacity</code> member. + /** Accessor for `capacity` member. */ uint32_t Get_Capacity(VArray *self); - /** Return all elements for which <code>test</code> returns true. + /** Return all elements for which `test` returns true. */ public incremented VArray* Gather(VArray *self, CFISH_VA_Gather_Test_t test, void *data); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/52eed70d/runtime/perl/xs/XSBind.h ---------------------------------------------------------------------- diff --git a/runtime/perl/xs/XSBind.h b/runtime/perl/xs/XSBind.h index 22189f9..5259f80 100644 --- a/runtime/perl/xs/XSBind.h +++ b/runtime/perl/xs/XSBind.h @@ -60,9 +60,9 @@ cfish_XSBind_sv_defined(SV *sv) { /** If the SV contains a Clownfish object which passes an "isa" test against the * passed-in Class, return a pointer to it. If not, but - * <code>allocation</code> is non-NULL and a StackString would satisfy the + * `allocation` is non-NULL and a StackString would satisfy the * "isa" test, stringify the SV, create a StackString using - * <code>allocation</code>, assign the SV's string to it, and return that + * `allocation`, assign the SV's string to it, and return that * instead. If all else fails, throw an exception. */ CFISH_VISIBLE cfish_Obj*
