Add clownfish URIs for methods
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/a6ba92ab Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/a6ba92ab Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/a6ba92ab Branch: refs/heads/master Commit: a6ba92ab4d0066e83553ba35316b195b03c2db74 Parents: 4620e32 Author: Nick Wellnhofer <[email protected]> Authored: Tue Dec 2 02:06:20 2014 +0100 Committer: Nick Wellnhofer <[email protected]> Committed: Wed Dec 24 16:02:04 2014 +0100 ---------------------------------------------------------------------- runtime/core/Clownfish/CharBuf.cfh | 4 ++-- runtime/core/Clownfish/Class.cfh | 2 +- runtime/core/Clownfish/Hash.cfh | 10 +++++----- runtime/core/Clownfish/Obj.cfh | 14 +++++++------- 4 files changed, 15 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a6ba92ab/runtime/core/Clownfish/CharBuf.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/CharBuf.cfh b/runtime/core/Clownfish/CharBuf.cfh index 0b1657f..f8134e5 100644 --- a/runtime/core/Clownfish/CharBuf.cfh +++ b/runtime/core/Clownfish/CharBuf.cfh @@ -92,7 +92,7 @@ class Clownfish::CharBuf nickname CB * hex: %x32 * * Note that all Clownfish Objects, including CharBufs, are printed via - * %o (which invokes Obj_To_String()). + * %o (which invokes [](cfish:Obj.To_String)). */ void VCatF(CharBuf *self, const char *pattern, va_list args); @@ -143,7 +143,7 @@ class Clownfish::CharBuf nickname CB To_String(CharBuf *self); /** Return the content of the CharBuf as String and clear the CharBuf. - * This is more efficient than To_String(). + * This is more efficient than [](cfish:.To_String). */ public incremented String* Yield_String(CharBuf *self); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a6ba92ab/runtime/core/Clownfish/Class.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Class.cfh b/runtime/core/Clownfish/Class.cfh index 4e5c085..e4dff41 100644 --- a/runtime/core/Clownfish/Class.cfh +++ b/runtime/core/Clownfish/Class.cfh @@ -45,7 +45,7 @@ class Clownfish::Class inherits Clownfish::Obj { * will be created using [parent] as a base. * * If [parent] is NULL, an attempt will be made to find it using - * Class_find_parent_class(). If the attempt fails, an error will + * [](cfish:.find_parent_class). If the attempt fails, an error will * result. */ inert Class* http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a6ba92ab/runtime/core/Clownfish/Hash.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Hash.cfh b/runtime/core/Clownfish/Hash.cfh index abc3f38..0b09785 100644 --- a/runtime/core/Clownfish/Hash.cfh +++ b/runtime/core/Clownfish/Hash.cfh @@ -20,8 +20,8 @@ parcel Clownfish; * Hashtable. * * Values are stored by reference and may be any kind of Obj. By default, keys - * are cloned and so must belong to a class that implements Clone(); however, - * this behavior can be changed by overridding Make_Key(), e.g. to implement + * are cloned and so must belong to a class that implements [](cfish:Obj.Clone); however, + * this behavior can be changed by overridding [](cfish:.Make_Key), e.g. to implement * efficient hash sets. */ class Clownfish::Hash inherits Clownfish::Obj { @@ -54,7 +54,7 @@ class Clownfish::Hash inherits Clownfish::Obj { Clear(Hash *self); /** Store a key-value pair. If `key` is not already present, - * Make_Key() will be called to manufacture the internally used key. + * [](cfish:.Make_Key) will be called to manufacture the internally used key. */ void Store(Hash *self, Obj *key, decremented Obj *value); @@ -117,8 +117,8 @@ class Clownfish::Hash inherits Clownfish::Obj { Values(Hash *self); /** Create a key to be stored within the hash entry. Implementations must - * supply an object which produces the same Hash_Sum() value and tests - * true for Equals(). By default, calls Clone(). + * supply an object which produces the same [](cfish:Obj.Hash_Sum) value and tests + * true for [](cfish:Obj.Equals). By default, calls [](cfish:Obj.Clone). */ public incremented Obj* Make_Key(Hash *self, Obj *key, int32_t hash_sum); http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/a6ba92ab/runtime/core/Clownfish/Obj.cfh ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Obj.cfh b/runtime/core/Clownfish/Obj.cfh index d3c9f59..930e1f5 100644 --- a/runtime/core/Clownfish/Obj.cfh +++ b/runtime/core/Clownfish/Obj.cfh @@ -40,25 +40,25 @@ public class Clownfish::Obj { incremented Obj* Inc_RefCount(Obj *self); - /** NULL-safe invocation of Inc_RefCount(). + /** NULL-safe invocation of [](cfish:.Inc_RefCount). * * @return NULL if `self` is NULL, otherwise the return value - * of Inc_RefCount(). + * of [](cfish:.Inc_RefCount). */ inert inline incremented Obj* incref(Obj *self); - /** Decrement an object's refcount, calling Destroy() if it hits 0. + /** Decrement an object's refcount, calling [](cfish:.Destroy) if it hits 0. * * @return the modified refcount. */ uint32_t Dec_RefCount(Obj *self); - /** NULL-safe invocation of Dec_RefCount(). + /** NULL-safe invocation of [](cfish:.Dec_RefCount). * * @return NULL if `self` is NULL, otherwise the return value - * of Dec_RefCount(). + * of [](cfish:.Dec_RefCount). */ inert inline uint32_t decref(Obj *self); @@ -79,7 +79,7 @@ public class Clownfish::Obj { public void Destroy(Obj *self); - /** Invoke the Destroy() method found in `klass` on + /** Invoke the [](cfish:.Destroy) method found in `klass` on * `self`. * * TODO: Eliminate this function if we can arrive at a proper SUPER syntax. @@ -142,7 +142,7 @@ public class Clownfish::Obj { To_F64(Obj *self); /** Evaluate the object in a boolean context. By default, invokes - * To_I64() and returns true if it is non-zero. + * [](cfish:.To_I64) and returns true if it is non-zero. */ public bool To_Bool(Obj *self);
