Repository: lucy Updated Branches: refs/heads/master c17ca4771 -> 516bea18e
Convert <code> markup to Markdown Project: http://git-wip-us.apache.org/repos/asf/lucy/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy/commit/217dbc4a Tree: http://git-wip-us.apache.org/repos/asf/lucy/tree/217dbc4a Diff: http://git-wip-us.apache.org/repos/asf/lucy/diff/217dbc4a Branch: refs/heads/master Commit: 217dbc4ad2e3d23cd52c1bba95627920e9a6e47d Parents: c17ca47 Author: Nick Wellnhofer <[email protected]> Authored: Mon Nov 10 00:39:58 2014 +0100 Committer: Nick Wellnhofer <[email protected]> Committed: Wed Dec 24 14:42:11 2014 +0100 ---------------------------------------------------------------------- core/Lucy/Analysis/Inversion.cfh | 2 +- core/Lucy/Analysis/RegexTokenizer.cfh | 14 ++++---- core/Lucy/Analysis/Token.cfh | 20 ++++++------ core/Lucy/Docs/FileLocking.cfh | 6 ++-- core/Lucy/Document/Doc.cfh | 2 +- core/Lucy/Highlight/HeatMap.cfh | 2 +- core/Lucy/Highlight/Highlighter.cfh | 6 ++-- core/Lucy/Index/DataReader.cfh | 2 +- core/Lucy/Index/DataWriter.cfh | 2 +- core/Lucy/Index/DeletionsWriter.cfh | 6 ++-- core/Lucy/Index/DocReader.cfh | 2 +- core/Lucy/Index/IndexManager.cfh | 6 ++-- core/Lucy/Index/Indexer.cfh | 6 ++-- core/Lucy/Index/Inverter.cfh | 4 +-- core/Lucy/Index/Lexicon.cfh | 2 +- core/Lucy/Index/LexiconReader.cfh | 2 +- core/Lucy/Index/PostingList.cfh | 2 +- core/Lucy/Index/PostingListReader.cfh | 4 +-- core/Lucy/Index/SegReader.cfh | 6 ++-- core/Lucy/Index/SegWriter.cfh | 4 +-- core/Lucy/Index/Segment.cfh | 6 ++-- core/Lucy/Index/SortCache.cfh | 6 ++-- core/Lucy/Object/BitVector.cfh | 8 ++--- core/Lucy/Object/I32Array.cfh | 8 ++--- core/Lucy/Plan/BlobType.cfh | 2 +- core/Lucy/Plan/FieldType.cfh | 40 +++++++++++------------ core/Lucy/Plan/Schema.cfh | 2 +- core/Lucy/Search/Collector.cfh | 2 +- core/Lucy/Search/Collector/SortCollector.cfh | 2 +- core/Lucy/Search/HitQueue.cfh | 2 +- core/Lucy/Search/IndexSearcher.cfh | 2 +- core/Lucy/Search/LeafQuery.cfh | 4 +-- core/Lucy/Search/Matcher.cfh | 2 +- core/Lucy/Search/QueryParser.cfh | 4 +-- core/Lucy/Search/QueryParser/ParserElem.cfh | 4 +-- core/Lucy/Search/QueryParser/QueryLexer.cfh | 2 +- core/Lucy/Search/RangeQuery.cfh | 16 ++++----- core/Lucy/Search/Searcher.cfh | 6 ++-- core/Lucy/Search/SortRule.cfh | 2 +- core/Lucy/Search/SortSpec.cfh | 2 +- core/Lucy/Search/Span.cfh | 12 +++---- core/Lucy/Search/TermQuery.cfh | 4 +-- core/Lucy/Search/TopDocs.cfh | 8 ++--- core/Lucy/Store/DirHandle.cfh | 2 +- core/Lucy/Store/FSFolder.cfh | 4 +-- core/Lucy/Store/FileHandle.cfh | 8 ++--- core/Lucy/Store/Folder.cfh | 32 +++++++++--------- core/Lucy/Store/InStream.cfh | 14 ++++---- core/Lucy/Store/Lock.cfh | 6 ++-- core/Lucy/Store/OutStream.cfh | 8 ++--- core/Lucy/Store/RAMFile.cfh | 4 +-- core/Lucy/Store/SharedLock.cfh | 4 +-- core/Lucy/Test/Search/TestQueryParser.cfh | 2 +- core/Lucy/Test/TestUtils.cfh | 4 +-- core/Lucy/Util/IndexFileNames.cfh | 2 +- core/Lucy/Util/Json.cfh | 6 ++-- core/Lucy/Util/Sleep.cfh | 4 +-- core/Lucy/Util/Stepper.cfh | 12 +++---- 58 files changed, 179 insertions(+), 179 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Analysis/Inversion.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Analysis/Inversion.cfh b/core/Lucy/Analysis/Inversion.cfh index 5303a43..d722181 100644 --- a/core/Lucy/Analysis/Inversion.cfh +++ b/core/Lucy/Analysis/Inversion.cfh @@ -64,7 +64,7 @@ class Lucy::Analysis::Inversion inherits Clownfish::Obj { Invert(Inversion *self); /** Return a pointer to the next group of like Tokens. The number of - * tokens in the cluster will be placed into <code>count</code>. + * tokens in the cluster will be placed into `count`. * * @param count The number of tokens in the cluster. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Analysis/RegexTokenizer.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Analysis/RegexTokenizer.cfh b/core/Lucy/Analysis/RegexTokenizer.cfh index 66590a4..9e35202 100644 --- a/core/Lucy/Analysis/RegexTokenizer.cfh +++ b/core/Lucy/Analysis/RegexTokenizer.cfh @@ -23,21 +23,21 @@ parcel Lucy; * tokenized into "three", "blind", "mice". * * Lucy::Analysis::RegexTokenizer decides where it should break up the text - * based on a regular expression compiled from a supplied <code>pattern</code> + * based on a regular expression compiled from a supplied `pattern` * matching one token. If our source string is... * * "Eats, Shoots and Leaves." * - * ... then a "whitespace tokenizer" with a <code>pattern</code> of - * <code>"\\S+"</code> produces... + * ... then a "whitespace tokenizer" with a `pattern` of + * `"\\S+"` produces... * * Eats, * Shoots * and * Leaves. * - * ... while a "word character tokenizer" with a <code>pattern</code> of - * <code>"\\w+"</code> produces... + * ... while a "word character tokenizer" with a `pattern` of + * `"\\w+"` produces... * * Eats * Shoots @@ -65,7 +65,7 @@ public class Lucy::Analysis::RegexTokenizer /** * @param pattern A string specifying a Perl-syntax regular expression * which should match one token. The default value is - * <code>\w+(?:[\x{2019}']\w+)*</code>, which matches "it's" as well as + * `\w+(?:[\x{2019}']\w+)*`, which matches "it's" as well as * "it" and "O'Henry's" as well as "Henry". */ public inert RegexTokenizer* @@ -85,7 +85,7 @@ public class Lucy::Analysis::RegexTokenizer Inversion *inversion); /** Set the compiled regular expression for matching a token. Also sets - * <code>pattern</code> as a side effect. + * `pattern` as a side effect. */ void Set_Token_RE(RegexTokenizer *self, void *token_re); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Analysis/Token.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Analysis/Token.cfh b/core/Lucy/Analysis/Token.cfh index 0ebfeb5..831f360 100644 --- a/core/Lucy/Analysis/Token.cfh +++ b/core/Lucy/Analysis/Token.cfh @@ -19,15 +19,15 @@ parcel Lucy; /** Unit of text. * * Token is the fundamental unit used by Apache Lucy's Analyzer subclasses. - * Each Token has 5 attributes: <code>text</code>, <code>start_offset</code>, - * <code>end_offset</code>, <code>boost</code>, and <code>pos_inc</code>. + * Each Token has 5 attributes: `text`, `start_offset`, + * `end_offset`, `boost`, and `pos_inc`. * - * The <code>text</code> attribute is a Unicode string encoded as UTF-8. + * The `text` attribute is a Unicode string encoded as UTF-8. * - * <code>start_offset</code> is the start point of the token text, measured in + * `start_offset` is the start point of the token text, measured in * Unicode code points from the top of the stored field; - * <code>end_offset</code> delimits the corresponding closing boundary. - * <code>start_offset</code> and <code>end_offset</code> locate the Token + * `end_offset` delimits the corresponding closing boundary. + * `start_offset` and `end_offset` locate the Token * within a larger context, even if the Token's text attribute gets modified * -- by stemming, for instance. The Token for "beating" in the text "beating * a dead horse" begins life with a start_offset of 0 and an end_offset of 7; @@ -35,19 +35,19 @@ parcel Lucy; * end_offset is still 7. This allows "beating" to be highlighted correctly * after a search matches "beat". * - * <code>boost</code> is a per-token weight. Use this when you want to assign + * `boost` is a per-token weight. Use this when you want to assign * more or less importance to a particular token, as you might for emboldened * text within an HTML document, for example. (Note: The field this token * belongs to must be spec'd to use a posting of type * L<Lucy::Index::Posting::RichPosting>.) * - * <code>pos_inc</code is the POSition INCrement, measured in Tokens. This + * `pos_inc` is the POSition INCrement, measured in Tokens. This * attribute, which defaults to 1, is a an advanced tool for manipulating * phrase matching. Ordinarily, Tokens are assigned consecutive position - * numbers: 0, 1, and 2 for <code>"three blind mice"</code>. However, if you + * numbers: 0, 1, and 2 for `"three blind mice"`. However, if you * set the position increment for "blind" to, say, 1000, then the three tokens * will end up assigned to positions 0, 1, and 1001 -- and will no longer - * produce a phrase match for the query <code>"three blind mice"</code>. + * produce a phrase match for the query `"three blind mice"`. */ class Lucy::Analysis::Token inherits Clownfish::Obj { http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Docs/FileLocking.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Docs/FileLocking.cfh b/core/Lucy/Docs/FileLocking.cfh index 4e96309..0192c71 100644 --- a/core/Lucy/Docs/FileLocking.cfh +++ b/core/Lucy/Docs/FileLocking.cfh @@ -27,13 +27,13 @@ parcel Lucy; * intervention becomes necessary. * * Both read and write applications accessing an index on a shared volume need - * to identify themselves with a unique <code>host</code> id, e.g. hostname or + * to identify themselves with a unique `host` id, e.g. hostname or * ip address. Knowing the host id makes it possible to tell which lockfiles * belong to other machines and therefore must not be removed when the * lockfile's pid number appears not to correspond to an active process. * * At index-time, the danger is that multiple indexing processes from - * different machines which fail to specify a unique <code>host</code> id can + * different machines which fail to specify a unique `host` id can * delete each others' lockfiles and then attempt to modify the index at the * same time, causing index corruption. The search-time problem is more * complex. @@ -71,7 +71,7 @@ parcel Lucy; * directory (as are exclusive locks), reader applications must have write * access for read locking to work. Stale lock files from crashed processes * are ordinarily cleared away the next time the same machine -- as identified - * by the <code>host</code> parameter -- opens another IndexReader. (The + * by the `host` parameter -- opens another IndexReader. (The * classic technique of timing out lock files is not feasible because search * processes may lie dormant indefinitely.) However, please be aware that if * the last thing a given machine does is crash, lock files belonging to it http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Document/Doc.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Document/Doc.cfh b/core/Lucy/Document/Doc.cfh index 003b2c3..94996a6 100644 --- a/core/Lucy/Document/Doc.cfh +++ b/core/Lucy/Document/Doc.cfh @@ -69,7 +69,7 @@ public class Lucy::Document::Doc inherits Clownfish::Obj { Get_Size(Doc *self); /** Retrieve the field's value, or NULL if the field is not present. If - * the field is a text type, assign it to <code>target</code>. Otherwise, + * the field is a text type, assign it to `target`. Otherwise, * return the interior object. Callers must check to verify the kind of * object returned. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Highlight/HeatMap.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Highlight/HeatMap.cfh b/core/Lucy/Highlight/HeatMap.cfh index 5424b55..5df3f45 100644 --- a/core/Lucy/Highlight/HeatMap.cfh +++ b/core/Lucy/Highlight/HeatMap.cfh @@ -58,7 +58,7 @@ class Lucy::Highlight::HeatMap inherits Clownfish::Obj { /** If the two spans overlap or abut, return a bonus equal to their summed * scores; as they move further apart, tail the bonus down until it hits 0 - * at the edge of the <code>window</code>. + * at the edge of the `window`. */ float Calc_Proximity_Boost(HeatMap *self, Span *span1, Span *span2); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Highlight/Highlighter.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Highlight/Highlighter.cfh b/core/Lucy/Highlight/Highlighter.cfh index 432d8dc..d27ff98 100644 --- a/core/Lucy/Highlight/Highlighter.cfh +++ b/core/Lucy/Highlight/Highlighter.cfh @@ -53,7 +53,7 @@ public class Lucy::Highlight::Highlighter inherits Clownfish::Obj { String *field, uint32_t excerpt_length = 200); /** Take a HitDoc object and return a highlighted excerpt as a string if - * the HitDoc has a value for the specified <code>field</code>. + * the HitDoc has a value for the specified `field`. */ public incremented String* Create_Excerpt(Highlighter *self, HitDoc *hit_doc); @@ -114,7 +114,7 @@ public class Lucy::Highlight::Highlighter inherits Clownfish::Obj { Get_Query(Highlighter *self); /** Accessor for the Lucy::Search::Compiler object derived from - * <code>query</code> and <code>searcher</code>. + * `query` and `searcher`. */ public Compiler* Get_Compiler(Highlighter *self); @@ -131,7 +131,7 @@ public class Lucy::Highlight::Highlighter inherits Clownfish::Obj { HeatMap *heat_map); /** Take the text in raw_excerpt, add highlight tags, encode, and place - * the result into <code>highlighted</code>. + * the result into `highlighted`. * * (Helper function for Create_Excerpt only exposed for testing purposes.) */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/DataReader.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/DataReader.cfh b/core/Lucy/Index/DataReader.cfh index 8b72d3c..f5f9988 100644 --- a/core/Lucy/Index/DataReader.cfh +++ b/core/Lucy/Index/DataReader.cfh @@ -38,7 +38,7 @@ public class Lucy::Index::DataReader inherits Clownfish::Obj { * @param snapshot A Snapshot. * @param segments An array of Segments. * @param seg_tick The array index of the Segment object within the - * <code>segments</code> array that this particular DataReader is assigned + * `segments` array that this particular DataReader is assigned * to, if any. A value of -1 indicates that no Segment should be * assigned. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/DataWriter.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/DataWriter.cfh b/core/Lucy/Index/DataWriter.cfh index c14fd04..efbb716 100644 --- a/core/Lucy/Index/DataWriter.cfh +++ b/core/Lucy/Index/DataWriter.cfh @@ -47,7 +47,7 @@ public class Lucy::Index::DataWriter inherits Clownfish::Obj { init(DataWriter *self, Schema *schema, Snapshot *snapshot, Segment *segment, PolyReader *polyreader); - /** Process a document, previously inverted by <code>inverter</code>. + /** Process a document, previously inverted by `inverter`. * * @param inverter An Inverter wrapping an inverted document. * @param doc_id Internal number assigned to this document within the http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/DeletionsWriter.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/DeletionsWriter.cfh b/core/Lucy/Index/DeletionsWriter.cfh index 68a2ad5..140e374 100644 --- a/core/Lucy/Index/DeletionsWriter.cfh +++ b/core/Lucy/Index/DeletionsWriter.cfh @@ -41,15 +41,15 @@ public abstract class Lucy::Index::DeletionsWriter nickname DelWriter /** Delete all documents in the index that index the supplied term. * * @param field The name of an indexed field. (If it is not spec'd as - * <code>indexed</code>, an error will occur.) + * `indexed`, an error will occur.) * @param term The term which identifies docs to be marked as deleted. If - * <code>field</code> is associated with an Analyzer, <code>term</code> + * `field` is associated with an Analyzer, `term` * will be processed automatically (so don't pre-process it yourself). */ public abstract void Delete_By_Term(DeletionsWriter *self, String *field, Obj *term); - /** Delete all documents in the index that match <code>query</code>. + /** Delete all documents in the index that match `query`. * * @param query A L<Query|Lucy::Search::Query>. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/DocReader.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/DocReader.cfh b/core/Lucy/Index/DocReader.cfh index b2d5b2f..182e2e3 100644 --- a/core/Lucy/Index/DocReader.cfh +++ b/core/Lucy/Index/DocReader.cfh @@ -29,7 +29,7 @@ public class Lucy::Index::DocReader inherits Lucy::Index::DataReader { Snapshot *snapshot = NULL, VArray *segments = NULL, int32_t seg_tick = -1); - /** Retrieve the document identified by <code>doc_id</code>. + /** Retrieve the document identified by `doc_id`. * * @return a HitDoc. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/IndexManager.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/IndexManager.cfh b/core/Lucy/Index/IndexManager.cfh index 0c5d867..03795cd 100644 --- a/core/Lucy/Index/IndexManager.cfh +++ b/core/Lucy/Index/IndexManager.cfh @@ -54,18 +54,18 @@ public class Lucy::Index::IndexManager nickname IxManager Destroy(IndexManager *self); /** - * Setter for <code>folder</code> member. Typical clients (Indexer, + * Setter for `folder` member. Typical clients (Indexer, * IndexReader) will use this method to install their own Folder instance. */ public void Set_Folder(IndexManager *self, Folder *folder = NULL); - /** Getter for <code>folder</code> member. + /** Getter for `folder` member. */ public nullable Folder* Get_Folder(IndexManager *self); - /** Getter for <code>host</code> member. + /** Getter for `host` member. */ public String* Get_Host(IndexManager *self); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/Indexer.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/Indexer.cfh b/core/Lucy/Index/Indexer.cfh index 9e15980..20dccf3 100644 --- a/core/Lucy/Index/Indexer.cfh +++ b/core/Lucy/Index/Indexer.cfh @@ -28,7 +28,7 @@ parcel Lucy; * If an index is located on a shared volume, each writer application must * identify itself by supplying an * L<IndexManager|Lucy::Index::IndexManager> with a unique - * <code>host</code> id to Indexer's constructor or index corruption will + * `host` id to Indexer's constructor or index corruption will * occur. See L<Lucy::Docs::FileLocking> for a detailed discussion. * * Note: at present, Delete_By_Term() and Delete_By_Query() only affect @@ -97,9 +97,9 @@ public class Lucy::Index::Indexer inherits Clownfish::Obj { * Commit() succeeds. * * @param field The name of an indexed field. (If it is not spec'd as - * <code>indexed</code>, an error will occur.) + * `indexed`, an error will occur.) * @param term The term which identifies docs to be marked as deleted. If - * <code>field</code> is associated with an Analyzer, <code>term</code> + * `field` is associated with an Analyzer, `term` * will be processed automatically (so don't pre-process it yourself). */ public void http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/Inverter.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/Inverter.cfh b/core/Lucy/Index/Inverter.cfh index 1f86238..7858a0a 100644 --- a/core/Lucy/Index/Inverter.cfh +++ b/core/Lucy/Index/Inverter.cfh @@ -48,13 +48,13 @@ class Lucy::Index::Inverter inherits Clownfish::Obj { public void Invert_Doc(Inverter *self, Doc *doc); - /** Set the object's <code>doc</code> member. Calls Clear() as side + /** Set the object's `doc` member. Calls Clear() as side * effect. */ public void Set_Doc(Inverter *self, Doc *doc); - /** Set the object's <code>boost</code> member. + /** Set the object's `boost` member. */ public void Set_Boost(Inverter *self, float boost); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/Lexicon.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/Lexicon.cfh b/core/Lucy/Index/Lexicon.cfh index 4c05e33..16058c1 100644 --- a/core/Lucy/Index/Lexicon.cfh +++ b/core/Lucy/Index/Lexicon.cfh @@ -42,7 +42,7 @@ public class Lucy::Index::Lexicon nickname Lex inherits Clownfish::Obj { Destroy(Lexicon *self); /** Seek the Lexicon to the first iterator state which is greater than or - * equal to <code>target</code>. If <code>target</code> is NULL, + * equal to `target`. If `target` is NULL, * reset the iterator. */ public abstract void http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/LexiconReader.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/LexiconReader.cfh b/core/Lucy/Index/LexiconReader.cfh index 34ce352..432822b 100644 --- a/core/Lucy/Index/LexiconReader.cfh +++ b/core/Lucy/Index/LexiconReader.cfh @@ -28,7 +28,7 @@ public abstract class Lucy::Index::LexiconReader nickname LexReader Snapshot *snapshot = NULL, VArray *segments = NULL, int32_t seg_tick = -1); - /** Return a new Lexicon for the given <code>field</code>. Will return + /** Return a new Lexicon for the given `field`. Will return * NULL if either the field is not indexed, or if no documents contain a * value for the field. * http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/PostingList.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/PostingList.cfh b/core/Lucy/Index/PostingList.cfh index 04c8a5b..702db7c 100644 --- a/core/Lucy/Index/PostingList.cfh +++ b/core/Lucy/Index/PostingList.cfh @@ -44,7 +44,7 @@ public class Lucy::Index::PostingList nickname PList Get_Doc_Freq(PostingList *self); /** Prepare the PostingList object to iterate over matches for documents - * that match <code>target</code>. + * that match `target`. * * @param target The term to match. If NULL, the iterator will be empty. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/PostingListReader.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/PostingListReader.cfh b/core/Lucy/Index/PostingListReader.cfh index 0f93526..a961fc9 100644 --- a/core/Lucy/Index/PostingListReader.cfh +++ b/core/Lucy/Index/PostingListReader.cfh @@ -29,8 +29,8 @@ public class Lucy::Index::PostingListReader nickname PListReader Folder *folder = NULL, Snapshot *snapshot = NULL, VArray *segments = NULL, int32_t seg_tick = -1); - /** Returns a PostingList, or NULL if either <code>field</code> is NULL or - * <code>field</code> is not present in any documents. + /** Returns a PostingList, or NULL if either `field` is NULL or + * `field` is not present in any documents. * * @param field A field name. * @param term If supplied, the PostingList will be pre-located to this http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/SegReader.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/SegReader.cfh b/core/Lucy/Index/SegReader.cfh index 44660fe..e34977e 100644 --- a/core/Lucy/Index/SegReader.cfh +++ b/core/Lucy/Index/SegReader.cfh @@ -46,7 +46,7 @@ public class Lucy::Index::SegReader inherits Lucy::Index::IndexReader { * Segment. * @param segments An array of Segment objects. * @param seg_tick The array index of the Segment object within - * <code>segments</code> that this particular SegReader is assigned to. + * `segments` that this particular SegReader is assigned to. */ inert SegReader* init(SegReader *self, Schema *schema, Folder *folder, @@ -55,11 +55,11 @@ public class Lucy::Index::SegReader inherits Lucy::Index::IndexReader { public void Destroy(SegReader *self); - /** Add a component to the SegReader. Using the same <code>api</code> key + /** Add a component to the SegReader. Using the same `api` key * twice is an error. * * @param api The name of the DataReader subclass that defines the - * interface implemented by <code>component</code>. + * interface implemented by `component`. * @param component A DataReader. */ public void http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/SegWriter.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/SegWriter.cfh b/core/Lucy/Index/SegWriter.cfh index 047525c..a7bad7e 100644 --- a/core/Lucy/Index/SegWriter.cfh +++ b/core/Lucy/Index/SegWriter.cfh @@ -60,7 +60,7 @@ public class Lucy::Index::SegWriter inherits Lucy::Index::DataWriter { * registration simply makes the writer available via Fetch(), so you may * also want to call Add_Writer()). * - * @param api The name of the DataWriter api which <code>writer</code> + * @param api The name of the DataWriter api which `writer` * implements. * @param component A DataWriter. */ @@ -88,7 +88,7 @@ public class Lucy::Index::SegWriter inherits Lucy::Index::DataWriter { void Prep_Seg_Dir(SegWriter *self); - /** Add a document to the segment. Inverts <code>doc</code>, increments + /** Add a document to the segment. Inverts `doc`, increments * the Segment's internal document id, then calls Add_Inverted_Doc(), * feeding all sub-writers. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/Segment.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/Segment.cfh b/core/Lucy/Index/Segment.cfh index 527bae0..a9f5ded 100644 --- a/core/Lucy/Index/Segment.cfh +++ b/core/Lucy/Index/Segment.cfh @@ -25,7 +25,7 @@ parcel Lucy; * * Each Segment object keeps track of information about an index segment: its * fields, document count, and so on. The Segment object itself writes one - * file, <code>segmeta.json</code>; besides storing info needed by Segment + * file, `segmeta.json`; besides storing info needed by Segment * itself, the "segmeta" file serves as a central repository for metadata * generated by other index components -- relieving them of the burden of * storing metadata themselves. @@ -67,7 +67,7 @@ public class Lucy::Index::Segment nickname Seg inherits Clownfish::Obj { Add_Field(Segment *self, String *field); /** Store arbitrary information in the segment's metadata Hash, to be - * serialized later. Throws an error if <code>key</code> is used twice. + * serialized later. Throws an error if `key` is used twice. * * @param key String identifying an index component. * @param metadata JSON-izable data structure. @@ -123,7 +123,7 @@ public class Lucy::Index::Segment nickname Seg inherits Clownfish::Obj { public int64_t Get_Count(Segment *self); - /** Add <code>increment</code> to the object's document count, then return + /** Add `increment` to the object's document count, then return * the new, modified total. */ int64_t http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Index/SortCache.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Index/SortCache.cfh b/core/Lucy/Index/SortCache.cfh index ff3408c..c2f351c 100644 --- a/core/Lucy/Index/SortCache.cfh +++ b/core/Lucy/Index/SortCache.cfh @@ -34,8 +34,8 @@ class Lucy::Index::SortCache inherits Clownfish::Obj { int32_t cardinality, int32_t doc_max, int32_t null_ord = -1, int32_t ord_width); - /** Return the value for ordinal <code>ord</code>, or NULL if the value - * for <code>ord</code> is NULL. + /** Return the value for ordinal `ord`, or NULL if the value + * for `ord` is NULL. */ public abstract nullable incremented Obj* Value(SortCache *self, int32_t ord); @@ -55,7 +55,7 @@ class Lucy::Index::SortCache inherits Clownfish::Obj { public int32_t Ordinal(SortCache *self, int32_t doc_id); - /** Attempt to find the ordinal of the supplied <code>term</code>. If the + /** Attempt to find the ordinal of the supplied `term`. If the * term cannot be found, return the ordinal of the term that would appear * immediately before it in sort order. * http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Object/BitVector.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Object/BitVector.cfh b/core/Lucy/Object/BitVector.cfh index 0079904..5359e54 100644 --- a/core/Lucy/Object/BitVector.cfh +++ b/core/Lucy/Object/BitVector.cfh @@ -37,7 +37,7 @@ public class Lucy::Object::BitVector nickname BitVec public inert BitVector* init(BitVector *self, uint32_t capacity = 0); - /** Return true if the bit at <code>tick</code> has been set, false if it + /** Return true if the bit at `tick` has been set, false if it * hasn't (regardless of whether it lies within the bounds of the * object's capacity). * @@ -46,7 +46,7 @@ public class Lucy::Object::BitVector nickname BitVec public bool Get(BitVector *self, uint32_t tick); - /** Set the bit at <code>tick</code> to 1. + /** Set the bit at `tick` to 1. * * @param tick The bit to be set. */ @@ -63,7 +63,7 @@ public class Lucy::Object::BitVector nickname BitVec uint32_t Get_Capacity(BitVector *self); - /** Returns the next set bit equal to or greater than <code>tick</code>, + /** Returns the next set bit equal to or greater than `tick`, * or -1 if no such bit exists. */ public int32_t @@ -90,7 +90,7 @@ public class Lucy::Object::BitVector nickname BitVec Grow(BitVector *self, uint32_t capacity); /** Modify the contents of this BitVector so that it has the same bits set - * as <code>other</code>. + * as `other`. * * @param other Another BitVector. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Object/I32Array.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Object/I32Array.cfh b/core/Lucy/Object/I32Array.cfh index 63be523..64f1d65 100644 --- a/core/Lucy/Object/I32Array.cfh +++ b/core/Lucy/Object/I32Array.cfh @@ -32,14 +32,14 @@ class Lucy::Object::I32Array nickname I32Arr inherits Clownfish::Obj { inert I32Array* init(I32Array *self, int32_t *ints, uint32_t size); - /** Set the value at <code>tick</code>, or throw an error if - * <code>tick</code> is out of bounds. + /** Set the value at `tick`, or throw an error if + * `tick` is out of bounds. */ void Set(I32Array *self, uint32_t tick, int32_t value); - /** Return the value at <code>tick</code>, or throw an error if - * <code>tick</code> is out of bounds. + /** Return the value at `tick`, or throw an error if + * `tick` is out of bounds. */ int32_t Get(I32Array *self, uint32_t tick); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Plan/BlobType.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/BlobType.cfh b/core/Lucy/Plan/BlobType.cfh index 35db51c..cd29bd1 100644 --- a/core/Lucy/Plan/BlobType.cfh +++ b/core/Lucy/Plan/BlobType.cfh @@ -37,7 +37,7 @@ public class Lucy::Plan::BlobType inherits Lucy::Plan::FieldType { public bool Binary(BlobType *self); - /** Throws an error unless <code>sortable</code> is false. + /** Throws an error unless `sortable` is false. */ public void Set_Sortable(BlobType *self, bool sortable); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Plan/FieldType.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/FieldType.cfh b/core/Lucy/Plan/FieldType.cfh index e645b78..3124493 100644 --- a/core/Lucy/Plan/FieldType.cfh +++ b/core/Lucy/Plan/FieldType.cfh @@ -43,31 +43,31 @@ __END_C__ * FieldType is an abstract class defining a set of traits and behaviors which * may be associated with one or more field names. * - * Properties which are common to all field types include <code>boost</code>, - * <code>indexed</code>, <code>stored</code>, <code>sortable</code>, - * <code>binary</code>, and <code>similarity</code>. + * Properties which are common to all field types include `boost`, + * `indexed`, `stored`, `sortable`, + * `binary`, and `similarity`. * - * The <code>boost</code> property is a floating point scoring multiplier + * The `boost` property is a floating point scoring multiplier * which defaults to 1.0. Values greater than 1.0 cause the field to * contribute more to a document's score, lower values, less. * - * The <code>indexed</code> property indicates whether the field should be + * The `indexed` property indicates whether the field should be * indexed (so that it can be searched). * - * The <code>stored</code> property indicates whether to store the raw field + * The `stored` property indicates whether to store the raw field * value, so that it can be retrieved when a document turns up in a search. * - * The <code>sortable</code> property indicates whether search results should + * The `sortable` property indicates whether search results should * be sortable based on the contents of the field. * - * The <code>binary</code> property indicates whether the field contains - * binary or text data. Unlike most other properties, <code>binary</code> is + * The `binary` property indicates whether the field contains + * binary or text data. Unlike most other properties, `binary` is * not settable. * - * The <code>similarity</code> property is a + * The `similarity` property is a * L<Similarity|Lucy::Index::Similarity> object which defines matching * and scoring behavior for the field. It is required if the field is - * <code>indexed</code>. + * `indexed`. */ public abstract class Lucy::Plan::FieldType nickname FType inherits Clownfish::Obj { @@ -84,42 +84,42 @@ public abstract class Lucy::Plan::FieldType nickname FType init2(FieldType *self, float boost = 1.0, bool indexed = false, bool stored = false, bool sortable = false); - /** Setter for <code>boost</code>. + /** Setter for `boost`. */ public void Set_Boost(FieldType *self, float boost); - /** Accessor for <code>boost</code>. + /** Accessor for `boost`. */ public float Get_Boost(FieldType *self); - /** Setter for <code>indexed</code>. + /** Setter for `indexed`. */ public void Set_Indexed(FieldType *self, bool indexed); - /** Accessor for <code>indexed</code>. + /** Accessor for `indexed`. */ public bool Indexed(FieldType *self); - /** Setter for <code>stored</code>. + /** Setter for `stored`. */ public void Set_Stored(FieldType *self, bool stored); - /** Accessor for <code>stored</code>. + /** Accessor for `stored`. */ public bool Stored(FieldType *self); - /** Setter for <code>sortable</code>. + /** Setter for `sortable`. */ public void Set_Sortable(FieldType *self, bool sortable); - /** Accessor for <code>sortable</code>. + /** Accessor for `sortable`. */ public bool Sortable(FieldType *self); @@ -130,7 +130,7 @@ public abstract class Lucy::Plan::FieldType nickname FType Binary(FieldType *self); /** Compare two values for the field. The default implementation - * dispatches to the Compare_To() method of argument <code>a</code>. + * dispatches to the Compare_To() method of argument `a`. * * @return a negative number if a is "less than" b, 0 if they are "equal", * and a positive number if a is "greater than" b. http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Plan/Schema.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/Schema.cfh b/core/Lucy/Plan/Schema.cfh index 9767d85..6d00eac 100644 --- a/core/Lucy/Plan/Schema.cfh +++ b/core/Lucy/Plan/Schema.cfh @@ -50,7 +50,7 @@ public class Lucy::Plan::Schema inherits Clownfish::Obj { /** Define the behavior of a field by associating it with a FieldType. * * If this method has already been called for the supplied - * <code>field</code>, it will merely test to verify that the supplied + * `field`, it will merely test to verify that the supplied * FieldType Equals() the existing one. * * @param name The name of the field. http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/Collector.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/Collector.cfh b/core/Lucy/Search/Collector.cfh index 97c83f0..0dd8cc3 100644 --- a/core/Lucy/Search/Collector.cfh +++ b/core/Lucy/Search/Collector.cfh @@ -57,7 +57,7 @@ public abstract class Lucy::Search::Collector nickname Coll Set_Reader(Collector *self, SegReader *reader); /** Set the "base" document id, an offset which must be added to the - * <code>doc_id</code> supplied via Collect() to get the doc id for the + * `doc_id` supplied via Collect() to get the doc id for the * larger index. */ public void http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/Collector/SortCollector.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/Collector/SortCollector.cfh b/core/Lucy/Search/Collector/SortCollector.cfh index 84ef161..2df7bb4 100644 --- a/core/Lucy/Search/Collector/SortCollector.cfh +++ b/core/Lucy/Search/Collector/SortCollector.cfh @@ -46,7 +46,7 @@ class Lucy::Search::Collector::SortCollector nickname SortColl new(Schema *schema = NULL, SortSpec *sort_spec = NULL, uint32_t wanted); /** - * @param schema A Schema. Required if <code>sort_spec</code> provided. + * @param schema A Schema. Required if `sort_spec` provided. * @param sort_spec A SortSpec. If NULL, sort by descending score first * and ascending doc id second. * @param wanted Maximum number of hits to collect. http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/HitQueue.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/HitQueue.cfh b/core/Lucy/Search/HitQueue.cfh index d76e6b8..b3f3923 100644 --- a/core/Lucy/Search/HitQueue.cfh +++ b/core/Lucy/Search/HitQueue.cfh @@ -34,7 +34,7 @@ class Lucy::Search::HitQueue nickname HitQ new(Schema *schema = NULL, SortSpec *sort_spec = NULL, uint32_t wanted); /** - * @param schema A Schema. Required if <code>sort_spec</code> supplied. + * @param schema A Schema. Required if `sort_spec` supplied. * @param sort_spec A SortSpec. If not supplied, the HitQueue will sort * by descending score first and ascending doc id second. * @param wanted Max elements the queue can hold. http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/IndexSearcher.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/IndexSearcher.cfh b/core/Lucy/Search/IndexSearcher.cfh index 2f74b25..2495c45 100644 --- a/core/Lucy/Search/IndexSearcher.cfh +++ b/core/Lucy/Search/IndexSearcher.cfh @@ -66,7 +66,7 @@ public class Lucy::Search::IndexSearcher nickname IxSearcher incremented DocVector* Fetch_Doc_Vec(IndexSearcher *self, int32_t doc_id); - /** Accessor for the object's <code>reader</code> member. + /** Accessor for the object's `reader` member. */ public IndexReader* Get_Reader(IndexSearcher *self); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/LeafQuery.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/LeafQuery.cfh b/core/Lucy/Search/LeafQuery.cfh index 63dea2f..b4d07f1 100644 --- a/core/Lucy/Search/LeafQuery.cfh +++ b/core/Lucy/Search/LeafQuery.cfh @@ -40,12 +40,12 @@ public class Lucy::Search::LeafQuery inherits Lucy::Search::Query { public inert LeafQuery* init(LeafQuery *self, String *field = NULL, String *text); - /** Accessor for object's <code>field</code> attribute. + /** Accessor for object's `field` attribute. */ public nullable String* Get_Field(LeafQuery *self); - /** Accessor for object's <code>text</code> attribute. + /** Accessor for object's `text` attribute. */ public String* Get_Text(LeafQuery *self); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/Matcher.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/Matcher.cfh b/core/Lucy/Search/Matcher.cfh index 7f6abdc..3d242b5 100644 --- a/core/Lucy/Search/Matcher.cfh +++ b/core/Lucy/Search/Matcher.cfh @@ -38,7 +38,7 @@ public abstract class Lucy::Search::Matcher inherits Clownfish::Obj { Next(Matcher *self); /** Advance the iterator to the first doc id greater than or equal to - * <code>target</code>. The default implementation simply calls Next() + * `target`. The default implementation simply calls Next() * over and over, but subclasses have the option of doing something more * efficient. * http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/QueryParser.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/QueryParser.cfh b/core/Lucy/Search/QueryParser.cfh index 89618f0..7bb2d86 100644 --- a/core/Lucy/Search/QueryParser.cfh +++ b/core/Lucy/Search/QueryParser.cfh @@ -126,7 +126,7 @@ public class Lucy::Search::QueryParser nickname QParser /** Prevent certain Query structures from returning too many results. * Query objects built via Tree() and Expand() can generate "return the * world" result sets, such as in the case of - * <code>NOT a_term_not_in_the_index</code>; Prune() walks the hierarchy + * `NOT a_term_not_in_the_index`; Prune() walks the hierarchy * and eliminates such branches. * * 'NOT foo' => [NOMATCH] @@ -217,7 +217,7 @@ public class Lucy::Search::QueryParser nickname QParser bool Heed_Colons(QueryParser *self); - /** Enable/disable parsing of <code>fieldname:foo</code> constructs. + /** Enable/disable parsing of `fieldname:foo` constructs. */ public void Set_Heed_Colons(QueryParser *self, bool heed_colons); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/QueryParser/ParserElem.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/QueryParser/ParserElem.cfh b/core/Lucy/Search/QueryParser/ParserElem.cfh index b07bb9b..c7d60d7 100644 --- a/core/Lucy/Search/QueryParser/ParserElem.cfh +++ b/core/Lucy/Search/QueryParser/ParserElem.cfh @@ -45,13 +45,13 @@ class Lucy::Search::QueryParser::ParserElem inherits Clownfish::Obj { uint32_t Get_Type(ParserElem *self); - /** Manipulate the value of <code>occur</code> so that the element becomes + /** Manipulate the value of `occur` so that the element becomes * forbidden. */ void Negate(ParserElem *self); - /** Manipulate the value of <code>occur</code> so that the element becomes + /** Manipulate the value of `occur` so that the element becomes * required. */ void http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/QueryParser/QueryLexer.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/QueryParser/QueryLexer.cfh b/core/Lucy/Search/QueryParser/QueryLexer.cfh index 5c345f9..e2f377c 100644 --- a/core/Lucy/Search/QueryParser/QueryLexer.cfh +++ b/core/Lucy/Search/QueryParser/QueryLexer.cfh @@ -37,7 +37,7 @@ class Lucy::Search::QueryParser::QueryLexer inherits Clownfish::Obj { bool Heed_Colons(QueryLexer *self); - /** Enable/disable parsing of <code>fieldname:foo</code> constructs. + /** Enable/disable parsing of `fieldname:foo` constructs. */ void Set_Heed_Colons(QueryLexer *self, bool heed_colons); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/RangeQuery.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/RangeQuery.cfh b/core/Lucy/Search/RangeQuery.cfh index fc83382..d4b133d 100644 --- a/core/Lucy/Search/RangeQuery.cfh +++ b/core/Lucy/Search/RangeQuery.cfh @@ -34,19 +34,19 @@ public class Lucy::Search::RangeQuery inherits Lucy::Search::Query { new(String *field, Obj *lower_term = NULL, Obj *upper_term = NULL, bool include_lower = true, bool include_upper = true); - /** Takes 5 parameters; <code>field</code> is required, as - * is at least one of either <code>lower_term</code> or - * <code>upper_term</code>. + /** Takes 5 parameters; `field` is required, as + * is at least one of either `lower_term` or + * `upper_term`. * - * @param field The name of a <code>sortable</code> field. + * @param field The name of a `sortable` field. * @param lower_term Lower delimiter. If not supplied, all values - * less than <code>upper_term</code> will pass. + * less than `upper_term` will pass. * @param upper_term Upper delimiter. If not supplied, all values greater - * than <code>lower_term</code> will pass. + * than `lower_term` will pass. * @param include_lower Indicates whether docs which match - * <code>lower_term</code> should be included in the results. + * `lower_term` should be included in the results. * @param include_upper Indicates whether docs which match - * <code>upper_term</code> should be included in the results. + * `upper_term` should be included in the results. */ public inert RangeQuery* init(RangeQuery *self, String *field, http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/Searcher.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/Searcher.cfh b/core/Lucy/Search/Searcher.cfh index 49c950e..c61ade3 100644 --- a/core/Lucy/Search/Searcher.cfh +++ b/core/Lucy/Search/Searcher.cfh @@ -67,10 +67,10 @@ public class Lucy::Search::Searcher inherits Clownfish::Obj { * @param query Either a Query object or a query string. * @param offset The number of most-relevant hits to discard, typically * used when "paging" through hits N at a time. Setting - * <code>offset</code> to 20 and <code>num_wanted</code> to 10 retrieves + * `offset` to 20 and `num_wanted` to 10 retrieves * hits 21-30, assuming that 30 hits can be found. * @param num_wanted The number of hits you would like to see after - * <code>offset</code> is taken into account. + * `offset` is taken into account. * @param sort_spec A L<Lucy::Search::SortSpec>, which will affect * how results are ranked and returned. */ @@ -106,7 +106,7 @@ public class Lucy::Search::Searcher inherits Clownfish::Obj { abstract incremented DocVector* Fetch_Doc_Vec(Searcher *self, int32_t doc_id); - /** Accessor for the object's <code>schema</code> member. + /** Accessor for the object's `schema` member. */ public Schema* Get_Schema(Searcher *self); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/SortRule.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/SortRule.cfh b/core/Lucy/Search/SortRule.cfh index cd2eba0..7a009c2 100644 --- a/core/Lucy/Search/SortRule.cfh +++ b/core/Lucy/Search/SortRule.cfh @@ -40,7 +40,7 @@ public class Lucy::Search::SortRule inherits Clownfish::Obj { /** * @param type Indicate whether to sort by score, field, etc. (The * default is to sort by a field.) - * @param field The name of a <code>sortable</code> field. + * @param field The name of a `sortable` field. * @param reverse If true, reverse the order of the sort for this rule. */ public inert incremented SortRule* http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/SortSpec.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/SortSpec.cfh b/core/Lucy/Search/SortSpec.cfh index a3e6ba5..0c59909 100644 --- a/core/Lucy/Search/SortSpec.cfh +++ b/core/Lucy/Search/SortSpec.cfh @@ -22,7 +22,7 @@ parcel Lucy; * you to indicate an alternate order via an array of * L<SortRules|Lucy::Search::SortRule>. * - * Fields you wish to sort against must be <code>sortable</code>. + * Fields you wish to sort against must be `sortable`. * * For a stable sort (important when paging through results), add a * sort-by-doc rule as the last SortRule. http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/Span.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/Span.cfh b/core/Lucy/Search/Span.cfh index e9d60df..43c17a1 100644 --- a/core/Lucy/Search/Span.cfh +++ b/core/Lucy/Search/Span.cfh @@ -44,32 +44,32 @@ public class Lucy::Search::Span inherits Clownfish::Obj { init(Span *self, int32_t offset, int32_t length, float weight = 0.0); - /** Accessor for <code>offset</code> attribute. + /** Accessor for `offset` attribute. */ public int32_t Get_Offset(Span *self); - /** Setter for <code>offset</code> attribute. + /** Setter for `offset` attribute. */ public void Set_Offset(Span *self, int32_t offset); - /** Accessor for <code>length</code> attribute. + /** Accessor for `length` attribute. */ public int32_t Get_Length(Span *self); - /** Setter for <code>length</code> attribute. + /** Setter for `length` attribute. */ public void Set_Length(Span *self, int32_t length); - /** Accessor for <code>weight</code> attribute. + /** Accessor for `weight` attribute. */ public float Get_Weight(Span *self); - /** Setter for <code>weight</code> attribute. + /** Setter for `weight` attribute. */ public void Set_Weight(Span *self, float weight); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/TermQuery.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/TermQuery.cfh b/core/Lucy/Search/TermQuery.cfh index cbdd42c..16d717f 100644 --- a/core/Lucy/Search/TermQuery.cfh +++ b/core/Lucy/Search/TermQuery.cfh @@ -38,12 +38,12 @@ public class Lucy::Search::TermQuery inherits Lucy::Search::Query { public inert TermQuery* init(TermQuery *self, String *field, Obj *term); - /** Accessor for object's <code>field</code> member. + /** Accessor for object's `field` member. */ public String* Get_Field(TermQuery *self); - /** Accessor for object's <code>term</code> member. + /** Accessor for object's `term` member. */ public Obj* Get_Term(TermQuery *self); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Search/TopDocs.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Search/TopDocs.cfh b/core/Lucy/Search/TopDocs.cfh index 985d8ea..69c21d6 100644 --- a/core/Lucy/Search/TopDocs.cfh +++ b/core/Lucy/Search/TopDocs.cfh @@ -32,22 +32,22 @@ class Lucy::Search::TopDocs inherits Clownfish::Obj { inert TopDocs* init(TopDocs *self, VArray *match_docs, uint32_t total_hits); - /** Accessor for <code>match_docs</code> member. + /** Accessor for `match_docs` member. */ VArray* Get_Match_Docs(TopDocs *self); - /** Setter for <code>match_docs</code> member. + /** Setter for `match_docs` member. */ void Set_Match_Docs(TopDocs *self, VArray *match_docs); - /** Accessor for <code>total_hits</code> member. + /** Accessor for `total_hits` member. */ uint32_t Get_Total_Hits(TopDocs *self); - /** Setter for <code>total_hits</code> member. + /** Setter for `total_hits` member. */ void Set_Total_Hits(TopDocs *self, uint32_t total_hits); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/DirHandle.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/DirHandle.cfh b/core/Lucy/Store/DirHandle.cfh index e8924d8..f300285 100644 --- a/core/Lucy/Store/DirHandle.cfh +++ b/core/Lucy/Store/DirHandle.cfh @@ -44,7 +44,7 @@ abstract class Lucy::Store::DirHandle nickname DH abstract bool Close(DirHandle *self); - /** Return the object's <code>dir</code> attribute. + /** Return the object's `dir` attribute. */ String* Get_Dir(DirHandle *self); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/FSFolder.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/FSFolder.cfh b/core/Lucy/Store/FSFolder.cfh index b4a7428..7d87745 100644 --- a/core/Lucy/Store/FSFolder.cfh +++ b/core/Lucy/Store/FSFolder.cfh @@ -36,12 +36,12 @@ public class Lucy::Store::FSFolder inherits Lucy::Store::Folder { public inert FSFolder* init(FSFolder *self, String *path); - /** Attempt to create the directory specified by <code>path</code>. + /** Attempt to create the directory specified by `path`. */ public void Initialize(FSFolder *self); - /** Verify that <code>path</code> is a directory. TODO: check + /** Verify that `path` is a directory. TODO: check * permissions. */ public bool http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/FileHandle.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/FileHandle.cfh b/core/Lucy/Store/FileHandle.cfh index 72d1c2c..4d4b394 100644 --- a/core/Lucy/Store/FileHandle.cfh +++ b/core/Lucy/Store/FileHandle.cfh @@ -55,7 +55,7 @@ abstract class Lucy::Store::FileHandle nickname FH do_open(FileHandle *self, String *path = NULL, uint32_t flags); /** Ensure that the FileWindow's buffer provides access to file data for - * <code>len</code> bytes starting at <code>offset</code>. + * `len` bytes starting at `offset`. * * @param window A FileWindow. * @param offset File position to begin at. @@ -99,7 +99,7 @@ abstract class Lucy::Store::FileHandle nickname FH Length(FileHandle *self); /** Advisory call alerting the FileHandle that it should prepare to occupy - * <code>len</code> bytes. The default implementation is a no-op. + * `len` bytes. The default implementation is a no-op. * * @return true on success, false on failure (sets Err_error). */ @@ -115,12 +115,12 @@ abstract class Lucy::Store::FileHandle nickname FH abstract bool Close(FileHandle *self); - /** Set the object's <code>path</code> attribute. + /** Set the object's `path` attribute. */ void Set_Path(FileHandle *self, String *path); - /** Return the object's <code>path</code> attribute. + /** Return the object's `path` attribute. */ nullable String* Get_Path(FileHandle *self); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/Folder.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/Folder.cfh b/core/Lucy/Store/Folder.cfh index dafa984..a275e14 100644 --- a/core/Lucy/Store/Folder.cfh +++ b/core/Lucy/Store/Folder.cfh @@ -37,12 +37,12 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { public void Destroy(Folder *self); - /** Getter for <code>path</code> member var. + /** Getter for `path` member var. */ public String* Get_Path(Folder *self); - /** Setter for <code>path</code> member var. + /** Setter for `path` member var. */ void Set_Path(Folder *self, String *path); @@ -106,18 +106,18 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { incremented VArray* List_R(Folder *self, String *path = NULL); - /** Indicate whether an entity exists at <code>path</code>. + /** Indicate whether an entity exists at `path`. * * @param path A relative filepath. - * @return true if <code>path</code> exists. + * @return true if `path` exists. */ public bool Exists(Folder *self, String *path); - /** Indicate whether a directory exists at <code>path</code>. + /** Indicate whether a directory exists at `path`. * * @param path A relative filepath. - * @return true if <code>path</code> is a directory. + * @return true if `path` is a directory. */ bool Is_Directory(Folder *self, String *path); @@ -130,7 +130,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { public bool Delete(Folder *self, String *path); - /** Delete recursively, starting at <code>path</code> + /** Delete recursively, starting at `path` * * @param path A relative filepath specifying a file or subdirectory. * @return true if the whole tree is deleted successfully, false if any @@ -140,7 +140,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { Delete_Tree(Folder *self, String *path); /** Rename a file or directory, or set Err_error and return false on - * failure. If an entry exists at <code>to</code>, the results are + * failure. If an entry exists at `to`, the results are * undefined. * * @param from The filepath prior to renaming. @@ -150,8 +150,8 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { public abstract bool Rename(Folder *self, String *from, String *to); - /** Create a hard link at path <code>to</code> pointing at the existing - * file <code>from</code>, or set Err_error and return false on failure. + /** Create a hard link at path `to` pointing at the existing + * file `from`, or set Err_error and return false on failure. * * @return true on success, false on failure. */ @@ -175,15 +175,15 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * the last component. E.g. the 'foo/bar' Folder for '/foo/bar/baz.txt', * the 'foo' Folder for 'foo/bar', etc. * - * If <code>path</code> is invalid, because an intermediate directory + * If `path` is invalid, because an intermediate directory * either doesn't exist or isn't a directory, return NULL. */ nullable Folder* Enclosing_Folder(Folder *self, String *path); - /** Return the Folder at the subdirectory specified by <code>path</code>. - * If <code>path</code> is NULL or an empty string, return this Folder. - * If the entity at <code>path</code> either doesn't exist or isn't a + /** Return the Folder at the subdirectory specified by `path`. + * If `path` is NULL or an empty string, return this Folder. + * If the entity at `path` either doesn't exist or isn't a * subdirectory, return NULL. * * @param path A relative filepath specifying a subdirectory. @@ -237,7 +237,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { Local_MkDir(Folder *self, String *name); /** Indicate whether a local entry exists for the supplied - * <code>name</code>. + * `name`. * * @param name The name of the local entry. */ @@ -245,7 +245,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { Local_Exists(Folder *self, String *name); /** Indicate whether a local subdirectory exists with the supplied - * <code>name</code>. + * `name`. * * @param name The name of the local subdirectory. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/InStream.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/InStream.cfh b/core/Lucy/Store/InStream.cfh index 9e57ee0..4bf7d27 100644 --- a/core/Lucy/Store/InStream.cfh +++ b/core/Lucy/Store/InStream.cfh @@ -53,7 +53,7 @@ class Lucy::Store::InStream inherits Clownfish::Obj { /** Clone the instream, but specify a new offset, length, and possibly * filename. Initial file position will be set to the top of the file - * (taking <code>offset</code> into account). + * (taking `offset` into account). * * @param filename An alias filename. If NULL, the filename of the * underlying FileHandle will be used. @@ -81,7 +81,7 @@ class Lucy::Store::InStream inherits Clownfish::Obj { public void Destroy(InStream *self); - /** Seek to <code>target</code>. + /** Seek to `target`. */ final void Seek(InStream *self, int64_t target); @@ -107,9 +107,9 @@ class Lucy::Store::InStream inherits Clownfish::Obj { void Fill(InStream *self, int64_t amount); - /** Get the InStream's buffer. Check to see whether <code>request</code> + /** Get the InStream's buffer. Check to see whether `request` * bytes are already in the buffer. If not, fill the buffer with either - * <code>request</code> bytes or the number of bytes remaining before EOF, + * `request` bytes or the number of bytes remaining before EOF, * whichever is smaller. * * @param request Advisory byte size request. @@ -125,7 +125,7 @@ class Lucy::Store::InStream inherits Clownfish::Obj { final void Advance_Buf(InStream *self, const char *buf); - /** Read <code>len</code> bytes from the InStream into <code>buf</code>. + /** Read `len` bytes from the InStream into `buf`. */ final void Read_Bytes(InStream *self, char *buf, size_t len); @@ -181,9 +181,9 @@ class Lucy::Store::InStream inherits Clownfish::Obj { final uint64_t Read_C64(InStream *self); - /** Read the bytes for a C32/C64 into <code>buf</code>. Return the number + /** Read the bytes for a C32/C64 into `buf`. Return the number * of bytes read. The caller must ensure that sufficient space exists in - * <code>buf</code> (worst case is 10 bytes). + * `buf` (worst case is 10 bytes). */ final int Read_Raw_C64(InStream *self, char *buf); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/Lock.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/Lock.cfh b/core/Lucy/Store/Lock.cfh index 33f2bde..dcd5fd9 100644 --- a/core/Lucy/Store/Lock.cfh +++ b/core/Lucy/Store/Lock.cfh @@ -55,8 +55,8 @@ public abstract class Lucy::Store::Lock inherits Clownfish::Obj { public abstract bool Shared(Lock *self); - /** Call Request() once per <code>interval</code> until Request() returns - * success or the <code>timeout</code> has been reached. + /** Call Request() once per `interval` until Request() returns + * success or the `timeout` has been reached. * * @return true on success, false on failure (sets Err_error). */ @@ -68,7 +68,7 @@ public abstract class Lucy::Store::Lock inherits Clownfish::Obj { * The semantics of Request() differ depending on whether Shared() returns * true. If the Lock is Shared(), then Request() should not fail if * another lock is held against the resource identified by - * <code>name</code> (though it might fail for other reasons). If it is + * `name` (though it might fail for other reasons). If it is * not Shared() -- i.e. it's an exclusive (write) lock -- then other locks * should cause Request() to fail. * http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/OutStream.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/OutStream.cfh b/core/Lucy/Store/OutStream.cfh index c4e2aad..5ffc9ca 100644 --- a/core/Lucy/Store/OutStream.cfh +++ b/core/Lucy/Store/OutStream.cfh @@ -43,7 +43,7 @@ class Lucy::Store::OutStream inherits Clownfish::Obj { inert nullable OutStream* do_open(OutStream *self, Obj *file); - /** Accessor for <code>path</code> member. + /** Accessor for `path` member. */ String* Get_Path(OutStream *self); @@ -54,7 +54,7 @@ class Lucy::Store::OutStream inherits Clownfish::Obj { Tell(OutStream *self); /** Write 0 or more null bytes to the OutStream until its file position is - * a multiple of <code>modulus</code>. + * a multiple of `modulus`. * * @return the new file position. */ @@ -72,12 +72,12 @@ class Lucy::Store::OutStream inherits Clownfish::Obj { Length(OutStream *self); /** Advisory call informing the OutStream that it should prepare to occupy - * <code>length</code> bytes. + * `length` bytes. */ void Grow(OutStream *self, int64_t length); - /** Write <code>len</code> bytes from <code>buf</code> to the OutStream. + /** Write `len` bytes from `buf` to the OutStream. */ final void Write_Bytes(OutStream *self, const void *buf, size_t len); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/RAMFile.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/RAMFile.cfh b/core/Lucy/Store/RAMFile.cfh index f58a03d..f9a0c71 100644 --- a/core/Lucy/Store/RAMFile.cfh +++ b/core/Lucy/Store/RAMFile.cfh @@ -38,12 +38,12 @@ class Lucy::Store::RAMFile inherits Clownfish::Obj { ByteBuf* Get_Contents(RAMFile *self); - /** Accessor for <code>read_only</code> property. + /** Accessor for `read_only` property. */ bool Read_Only(RAMFile *self); - /** Set the object's <code>read_only</code> property. + /** Set the object's `read_only` property. */ void Set_Read_Only(RAMFile *self, bool read_only); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Store/SharedLock.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/SharedLock.cfh b/core/Lucy/Store/SharedLock.cfh index df08809..e409e79 100644 --- a/core/Lucy/Store/SharedLock.cfh +++ b/core/Lucy/Store/SharedLock.cfh @@ -24,10 +24,10 @@ parcel Lucy; * semantics of two methods. * * First, Obtain() will not fail if another lock is held against the resource - * identified by <code>name</code> (though it might fail for other reasons). + * identified by `name` (though it might fail for other reasons). * * Second, Is_Locked() returns true so long as some lock, somewhere is holding - * a lock on <code>name</code>. That lock could be this instance, or it could + * a lock on `name`. That lock could be this instance, or it could * be another -- so is entirely possible to call Release() successfully on a * SharedLock object yet still have Is_Locked() return true. * http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Test/Search/TestQueryParser.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Test/Search/TestQueryParser.cfh b/core/Lucy/Test/Search/TestQueryParser.cfh index 76ed047..4c900d5 100644 --- a/core/Lucy/Test/Search/TestQueryParser.cfh +++ b/core/Lucy/Test/Search/TestQueryParser.cfh @@ -28,7 +28,7 @@ class Lucy::Test::Search::TestQueryParser nickname TestQP uint32_t num_hits; /** Note that unlike most Clownfish constructors, this routine will consume one - * reference count each for <code>tree</code>, and <code>expanded</code>. + * reference count each for `tree`, and `expanded`. */ inert incremented TestQueryParser* new(const char *query_string = NULL, Query *tree = NULL, http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Test/TestUtils.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Test/TestUtils.cfh b/core/Lucy/Test/TestUtils.cfh index 68c0d5f..37c0ce9 100644 --- a/core/Lucy/Test/TestUtils.cfh +++ b/core/Lucy/Test/TestUtils.cfh @@ -40,7 +40,7 @@ inert class Lucy::Test::TestUtils { make_leaf_query(const char *field, const char *term); /** Return a new NOTQuery, decrementing the refcount for - * <code>negated_query</code>. + * `negated_query`. */ inert incremented NOTQuery* make_not_query(Query *negated_query); @@ -52,7 +52,7 @@ inert class Lucy::Test::TestUtils { bool include_upper = true); /** Return either an ORQuery or an ANDQuery depending on the value of - * <code>boolop</code>. Takes a NULL-terminated list of Query objects. + * `boolop`. Takes a NULL-terminated list of Query objects. * Decrements the refcounts of all supplied children, under the assumption * that they were created solely for inclusion within the aggregate query. */ http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Util/IndexFileNames.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/IndexFileNames.cfh b/core/Lucy/Util/IndexFileNames.cfh index d74f37b..e1bbff3 100644 --- a/core/Lucy/Util/IndexFileNames.cfh +++ b/core/Lucy/Util/IndexFileNames.cfh @@ -35,7 +35,7 @@ inert class Lucy::Util::IndexFileNames nickname IxFileNames { inert incremented nullable String* latest_snapshot(Folder *folder); - /** Split the <code>path</code> on '/' and return the last component. + /** Split the `path` on '/' and return the last component. * Trailing slashes will be stripped. */ inert incremented String* http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Util/Json.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/Json.cfh b/core/Lucy/Util/Json.cfh index c103074..daa3f86 100644 --- a/core/Lucy/Util/Json.cfh +++ b/core/Lucy/Util/Json.cfh @@ -22,7 +22,7 @@ parcel Lucy; */ class Lucy::Util::Json inherits Clownfish::Obj { - /** Encode <code>dump</code> as JSON. Returns NULL and sets Err_error on + /** Encode `dump` as JSON. Returns NULL and sets Err_error on * failure. */ inert incremented nullable String* @@ -35,14 +35,14 @@ class Lucy::Util::Json inherits Clownfish::Obj { inert incremented nullable Obj* from_json(String *json); - /** Encode <code>dump</code> as JSON and attempt to write to the indicated + /** Encode `dump` as JSON and attempt to write to the indicated * file. * @return true if the write succeeds, false on failure (sets Err_error). */ inert bool spew_json(Obj *dump, Folder *folder, String *path); - /** Decode the JSON in the file at <code>path</code> and return a data + /** Decode the JSON in the file at `path` and return a data * structure made of Hashes, VArrays, and Strings. Returns NULL and sets * Err_error if the file can't be can't be opened or if the file doesn't * contain valid JSON. http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Util/Sleep.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/Sleep.cfh b/core/Lucy/Util/Sleep.cfh index fa5bb3a..6155e7a 100644 --- a/core/Lucy/Util/Sleep.cfh +++ b/core/Lucy/Util/Sleep.cfh @@ -20,12 +20,12 @@ parcel Lucy; */ inert class Lucy::Util::Sleep { - /** Sleep for <code>seconds</code> seconds. + /** Sleep for `seconds` seconds. */ inert void sleep(uint32_t seconds); - /** Sleep for <code>milliseconds</code> milliseconds. + /** Sleep for `milliseconds` milliseconds. */ inert void millisleep(uint32_t milliseconds); http://git-wip-us.apache.org/repos/asf/lucy/blob/217dbc4a/core/Lucy/Util/Stepper.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Util/Stepper.cfh b/core/Lucy/Util/Stepper.cfh index bb05a01..36ed485 100644 --- a/core/Lucy/Util/Stepper.cfh +++ b/core/Lucy/Util/Stepper.cfh @@ -43,8 +43,8 @@ class Lucy::Util::Stepper inherits Clownfish::Obj { public abstract void Reset(Stepper* self); - /** Update internal state to reflect <code>value</code> and write a frame - * to <code>outstream</code> that can be read using Read_Key_Frame(). + /** Update internal state to reflect `value` and write a frame + * to `outstream` that can be read using Read_Key_Frame(). * * @param outstream An OutStream. * @param value State information. @@ -52,8 +52,8 @@ class Lucy::Util::Stepper inherits Clownfish::Obj { public abstract void Write_Key_Frame(Stepper *self, OutStream *outstream, Obj *value); - /** Update internal state to reflect <code>value</code> and write a frame - * to <code>outstream</code> that can be read using Read_Delta(). + /** Update internal state to reflect `value` and write a frame + * to `outstream` that can be read using Read_Delta(). * * @param outstream An OutStream. * @param value State information. @@ -61,7 +61,7 @@ class Lucy::Util::Stepper inherits Clownfish::Obj { public abstract void Write_Delta(Stepper *self, OutStream *outstream, Obj *value); - /** Update intern state using information read from <code>instream</code>. + /** Update intern state using information read from `instream`. * * @param instream An InStream. */ @@ -69,7 +69,7 @@ class Lucy::Util::Stepper inherits Clownfish::Obj { Read_Key_Frame(Stepper *self, InStream *instream); /** Update state using a combination of information from - * <code>instream</code> and the current internal state. + * `instream` and the current internal state. */ public abstract void Read_Delta(Stepper *self, InStream *instream);
