Repository: lucy Updated Branches: refs/heads/markdown 82d38667a -> af11daf0b
http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Store/RAMFolder.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/RAMFolder.cfh b/core/Lucy/Store/RAMFolder.cfh index 731d414..c3e5964 100644 --- a/core/Lucy/Store/RAMFolder.cfh +++ b/core/Lucy/Store/RAMFolder.cfh @@ -19,7 +19,7 @@ parcel Lucy; /** In-memory Folder implementation. * * RAMFolder is an entirely in-memory implementation of - * [Folder](clownfish:class:Folder), primarily used for testing and development. + * [](cfish:Folder), primarily used for testing and development. */ public class Lucy::Store::RAMFolder inherits Lucy::Store::Folder { http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Store/SharedLock.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/SharedLock.cfh b/core/Lucy/Store/SharedLock.cfh index b4a6462..ba0fca2 100644 --- a/core/Lucy/Store/SharedLock.cfh +++ b/core/Lucy/Store/SharedLock.cfh @@ -19,17 +19,17 @@ parcel Lucy; /** Shared (read) lock. * * SharedLock's interface is nearly identical to that of its parent class - * [Lock](clownfish:class:Lock), taking the same constructor arguments and + * [](cfish:Lock), taking the same constructor arguments and * implementing the same list of methods. It differs from Lock only in the * semantics of two methods. * - * First, [Obtain()](clownfish:method:Obtain) will not fail if another lock is held against the resource + * First, [](cfish:.Obtain) will not fail if another lock is held against the resource * identified by `name` (though it might fail for other reasons). * - * Second, [Is_Locked()](clownfish:method:Is_Locked) returns true so long as some lock, somewhere is holding + * Second, [](cfish:.Is_Locked) returns true so long as some lock, somewhere is holding * a lock on `name`. That lock could be this instance, or it could - * be another -- so is entirely possible to call [Release()](clownfish:method:Release) successfully on a - * SharedLock object yet still have [Is_Locked()](clownfish:method:Is_Locked) return true. + * be another -- so is entirely possible to call [](cfish:.Release) successfully on a + * SharedLock object yet still have [](cfish:.Is_Locked) return true. * * As currently implemented, SharedLock differs from Lock in that each caller * gets its own lockfile. Lockfiles still have filenames which begin with the @@ -51,7 +51,7 @@ class Lucy::Store::SharedLock nickname ShLock * @param name String identifying the resource to be locked. * @param host An identifier which should be unique per-machine. * @param timeout Time in milliseconds to keep retrying before abandoning - * the attempt to [Obtain()](clownfish:method:Obtain) a lock. + * the attempt to [](cfish:.Obtain) a lock. * @param interval Time in milliseconds between retries. */ public inert SharedLock* http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Test/Plan/TestArchitecture.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Test/Plan/TestArchitecture.cfh b/core/Lucy/Test/Plan/TestArchitecture.cfh index dc4883b..dafd5e7 100644 --- a/core/Lucy/Test/Plan/TestArchitecture.cfh +++ b/core/Lucy/Test/Plan/TestArchitecture.cfh @@ -17,7 +17,7 @@ parcel TestLucy; /** - * Returns absurdly low values for [Index_Interval()](clownfish:method:Index_Interval) and [Skip_Interval()](clownfish:method:Skip_Interval). + * Returns absurdly low values for [](cfish:.Index_Interval) and [](cfish:.Skip_Interval). */ class Lucy::Test::Plan::TestArchitecture nickname TestArch http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Test/TestSchema.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Test/TestSchema.cfh b/core/Lucy/Test/TestSchema.cfh index 219698b..5cd897a 100644 --- a/core/Lucy/Test/TestSchema.cfh +++ b/core/Lucy/Test/TestSchema.cfh @@ -19,7 +19,7 @@ parcel TestLucy; /** Schema for use by the test suite. * * Exposes problems faced by much larger indexes by using an TestArchitecture, - * which returns absurdly low values for [Index_Interval()](clownfish:method:Index_Interval) and [Skip_Interval()](clownfish:method:Skip_Interval). + * which returns absurdly low values for [](cfish:.Index_Interval) and [](cfish:.Skip_Interval). */ class Lucy::Test::TestSchema inherits Lucy::Plan::Schema { http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Util/Debug.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/Debug.cfh b/core/Lucy/Util/Debug.cfh index 5ba535a..1b61594 100644 --- a/core/Lucy/Util/Debug.cfh +++ b/core/Lucy/Util/Debug.cfh @@ -98,7 +98,7 @@ __C__ /** Abort on error if test fails. * - * Note: unlike the system assert(), this [ASSERT()](clownfish:method:ASSERT) is #ifdef LUCY_DEBUG. + * Note: unlike the system assert(), this [](cfish:.ASSERT) is #ifdef LUCY_DEBUG. */ #define LUCY_ASSERT(test , args...) \ do { \ http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Util/Freezer.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/Freezer.cfh b/core/Lucy/Util/Freezer.cfh index 0cde753..e3992e8 100644 --- a/core/Lucy/Util/Freezer.cfh +++ b/core/Lucy/Util/Freezer.cfh @@ -43,7 +43,7 @@ inert class Lucy::Util::Freezer { /** Return a representation of the object using only scalars, hashes, and * arrays. Some classes support JSON serialization via dump() and its * companion, load(); for others, dump() is only a debugging aid. - * The default simply calls [To_String()](clownfish:method:To_String). + * The default simply calls [](cfish:.To_String). */ inert incremented Obj* dump(Obj *obj); http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Util/PriorityQueue.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/PriorityQueue.cfh b/core/Lucy/Util/PriorityQueue.cfh index 7c0e267..1d19d32 100644 --- a/core/Lucy/Util/PriorityQueue.cfh +++ b/core/Lucy/Util/PriorityQueue.cfh @@ -53,8 +53,8 @@ class Lucy::Util::PriorityQueue nickname PriQ bool Insert(PriorityQueue *self, decremented Obj *element); - /** Equivalent to [Insert()](clownfish:method:Insert), except for the return value. If the Queue has - * room, the element is inserted and [Jostle()](clownfish:method:Jostle) returns NULL. If not, then + /** Equivalent to [](cfish:.Insert), except for the return value. If the Queue has + * room, the element is inserted and [](cfish:.Jostle) returns NULL. If not, then * the item which falls out of the bottom of the Queue is returned. */ incremented nullable Obj* http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Util/SortExternal.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/SortExternal.cfh b/core/Lucy/Util/SortExternal.cfh index d8420ff..29ffebe 100644 --- a/core/Lucy/Util/SortExternal.cfh +++ b/core/Lucy/Util/SortExternal.cfh @@ -19,19 +19,19 @@ parcel Lucy; /** Abstract external sorter. * * SortExternal objects are sort pools which allow you to sort huge - * collections of elements. To achieve this, you [Feed()](clownfish:method:Feed) all items into the - * SortExternal object, [Flip()](clownfish:method:Flip) it from write mode to read mode, then [Fetch()](clownfish:method:Fetch) + * collections of elements. To achieve this, you [](cfish:.Feed) all items into the + * SortExternal object, [](cfish:.Flip) it from write mode to read mode, then [](cfish:.Fetch) * the elements one at a time in sorted order. * * It's expected that the total memory footprint of the buffered sortable * items will eventually exceed a specified threshold; at that point, the - * SortExternal object will call the abstract method [Flush()](clownfish:method:Flush). It's expected - * that [Flush()](clownfish:method:Flush) implementations will empty out the current buffer, write a + * SortExternal object will call the abstract method [](cfish:.Flush). It's expected + * that [](cfish:.Flush) implementations will empty out the current buffer, write a * sorted "run" to external storage, and add a new child SortExternal object * to the top level object's "runs" array to represent the flushed content. * * During the read phase, the child sortex objects retrieve elements from - * external storage by calling the abstract method [Refill()](clownfish:method:Refill). The top-level + * external storage by calling the abstract method [](cfish:.Refill). The top-level * SortExternal object then interleaves multiple sorted streams to produce a * single unified stream of sorted items. */ @@ -63,7 +63,7 @@ abstract class Lucy::Util::SortExternal nickname SortEx * * Presumably this entails sorting everything, writing the sorted elements * to disk, spawning a child object to represent those elements, and - * adding that child to the top-level object via [Add_Run()](clownfish:method:Add_Run). + * adding that child to the top-level object via [](cfish:.Add_Run). */ abstract void Flush(SortExternal *self); @@ -79,13 +79,13 @@ abstract class Lucy::Util::SortExternal nickname SortEx Flip(SortExternal *self); /** Fetch the next sorted item from the sort pool. Invalid prior to - * calling [Flip()](clownfish:method:Flip). Returns NULL when all elements have been exhausted. + * calling [](cfish:.Flip). Returns NULL when all elements have been exhausted. */ incremented nullable Obj* Fetch(SortExternal *self); /** Preview the next item that Fetch will return, but don't pop it. - * Invalid prior to calling [Flip()](clownfish:method:Flip). + * Invalid prior to calling [](cfish:.Flip). */ nullable Obj* Peek(SortExternal *self); http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/Lucy/Util/Stepper.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/Stepper.cfh b/core/Lucy/Util/Stepper.cfh index 73d0003..517118b 100644 --- a/core/Lucy/Util/Stepper.cfh +++ b/core/Lucy/Util/Stepper.cfh @@ -44,7 +44,7 @@ class Lucy::Util::Stepper inherits Clownfish::Obj { Reset(Stepper* self); /** Update internal state to reflect `value` and write a frame - * to `outstream` that can be read using [Read_Key_Frame()](clownfish:method:Read_Key_Frame). + * to `outstream` that can be read using [](cfish:.Read_Key_Frame). * * @param outstream An OutStream. * @param value State information. @@ -53,7 +53,7 @@ class Lucy::Util::Stepper inherits Clownfish::Obj { Write_Key_Frame(Stepper *self, OutStream *outstream, Obj *value); /** Update internal state to reflect `value` and write a frame - * to `outstream` that can be read using [Read_Delta()](clownfish:method:Read_Delta). + * to `outstream` that can be read using [](cfish:.Read_Delta). * * @param outstream An OutStream. * @param value State information. http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/LucyX/Search/MockMatcher.cfh ---------------------------------------------------------------------- diff --git a/core/LucyX/Search/MockMatcher.cfh b/core/LucyX/Search/MockMatcher.cfh index f25877a..4115575 100644 --- a/core/LucyX/Search/MockMatcher.cfh +++ b/core/LucyX/Search/MockMatcher.cfh @@ -29,7 +29,7 @@ class LucyX::Search::MockMatcher inherits Lucy::Search::Matcher { /** * @param doc_ids An array of matching doc ids. * @param scores Float scores corresponding to the doc ids array. If not - * supplied, calling [Score()](clownfish:method:Score) will throw an exception. + * supplied, calling [](cfish:.Score) will throw an exception. */ inert incremented MockMatcher* init(MockMatcher *self, I32Array *doc_ids, ByteBuf *scores = NULL); http://git-wip-us.apache.org/repos/asf/lucy/blob/af11daf0/core/LucyX/Search/ProximityQuery.cfh ---------------------------------------------------------------------- diff --git a/core/LucyX/Search/ProximityQuery.cfh b/core/LucyX/Search/ProximityQuery.cfh index 7e1eab3..f4e0584 100644 --- a/core/LucyX/Search/ProximityQuery.cfh +++ b/core/LucyX/Search/ProximityQuery.cfh @@ -18,7 +18,7 @@ parcel Lucy; /** Query matching an ordered list of terms. * - * ProximityQuery is a subclass of [Query](clownfish:class:Query) for matching + * ProximityQuery is a subclass of [](cfish:Query) for matching * against an ordered sequence of terms. */
