lucy-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nwelln...@apache.org
Subject lucy git commit: Replace "NULL" with "[](cfish:@null)"
Date Sun, 04 Jan 2015 20:17:18 GMT
Repository: lucy
Updated Branches:
  refs/heads/master 946304aae -> 750dcb6fc


Replace "NULL" with "[](cfish:@null)"


Project: http://git-wip-us.apache.org/repos/asf/lucy/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy/commit/750dcb6f
Tree: http://git-wip-us.apache.org/repos/asf/lucy/tree/750dcb6f
Diff: http://git-wip-us.apache.org/repos/asf/lucy/diff/750dcb6f

Branch: refs/heads/master
Commit: 750dcb6fc3b3e0b0240cc73f0df04c8270797acb
Parents: 946304a
Author: Nick Wellnhofer <wellnhofer@aevum.de>
Authored: Sun Jan 4 21:15:29 2015 +0100
Committer: Nick Wellnhofer <wellnhofer@aevum.de>
Committed: Sun Jan 4 21:15:29 2015 +0100

----------------------------------------------------------------------
 core/Lucy/Index/DataReader.cfh        |  2 +-
 core/Lucy/Index/IndexReader.cfh       |  3 ++-
 core/Lucy/Index/Lexicon.cfh           |  6 +++---
 core/Lucy/Index/LexiconReader.cfh     |  7 ++++---
 core/Lucy/Index/PostingList.cfh       |  3 ++-
 core/Lucy/Index/PostingListReader.cfh |  8 ++++----
 core/Lucy/Index/Segment.cfh           |  4 ++--
 core/Lucy/Index/Snapshot.cfh          | 10 +++++-----
 core/Lucy/Plan/Schema.cfh             |  7 ++++---
 core/Lucy/Search/Compiler.cfh         |  4 ++--
 core/Lucy/Search/Hits.cfh             |  2 +-
 core/Lucy/Search/QueryParser.cfh      |  2 +-
 12 files changed, 31 insertions(+), 27 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Index/DataReader.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Index/DataReader.cfh b/core/Lucy/Index/DataReader.cfh
index e759f4f..2000d95 100644
--- a/core/Lucy/Index/DataReader.cfh
+++ b/core/Lucy/Index/DataReader.cfh
@@ -48,7 +48,7 @@ public class Lucy::Index::DataReader inherits Clownfish::Obj {
          int32_t seg_tick = -1);
 
     /** Create a reader which aggregates the output of several lower level
-     * readers.  Return NULL if such a reader is not valid.
+     * readers.  Return [](cfish:@null) if such a reader is not valid.
      *
      * @param readers An array of DataReaders.
      * @param offsets Doc id start offsets for each reader.

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Index/IndexReader.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Index/IndexReader.cfh b/core/Lucy/Index/IndexReader.cfh
index c0becb0..ed58e9e 100644
--- a/core/Lucy/Index/IndexReader.cfh
+++ b/core/Lucy/Index/IndexReader.cfh
@@ -104,7 +104,8 @@ public class Lucy::Index::IndexReader nickname IxReader
     public DataReader*
     Obtain(IndexReader *self, String *api);
 
-    /** Fetch a component, or return NULL if the component can't be found.
+    /** Fetch a component, or return [](cfish:@null) if the component can't be
+     * found.
      *
      * @param api The name of the DataReader subclass that the desired
      * component must implement.

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Index/Lexicon.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Index/Lexicon.cfh b/core/Lucy/Index/Lexicon.cfh
index 686f931..8025c1a 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 `target`.  If `target` is NULL,
+     * equal to `target`.  If `target` is [](cfish:@null),
      * reset the iterator.
      */
     public abstract void
@@ -67,8 +67,8 @@ public class Lucy::Index::Lexicon nickname Lex inherits Clownfish::Obj {
     public abstract int32_t
     Doc_Freq(Lexicon *self);
 
-    /** Return the current term, or NULL if the iterator is not in a valid
-     * state.
+    /** Return the current term, or [](cfish:@null) if the iterator is not in a
+     * valid state.
      */
     public abstract nullable Obj*
     Get_Term(Lexicon *self);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Index/LexiconReader.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Index/LexiconReader.cfh b/core/Lucy/Index/LexiconReader.cfh
index 432822b..f98416a 100644
--- a/core/Lucy/Index/LexiconReader.cfh
+++ b/core/Lucy/Index/LexiconReader.cfh
@@ -29,8 +29,8 @@ public abstract class Lucy::Index::LexiconReader nickname LexReader
         int32_t seg_tick = -1);
 
     /** 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.
+     * [](cfish:@null) if either the field is not indexed, or if no documents
+     * contain a value for the field.
      *
      * @param field Field name.
      * @param term Pre-locate the Lexicon to this term.
@@ -43,7 +43,8 @@ public abstract class Lucy::Index::LexiconReader nickname LexReader
     public abstract uint32_t
     Doc_Freq(LexiconReader *self, String *field, Obj *term);
 
-    /** If the term can be found, return a term info, otherwise return NULL.
+    /** If the term can be found, return a term info, otherwise return
+     * [](cfish:@null).
      */
     abstract incremented nullable TermInfo*
     Fetch_Term_Info(LexiconReader *self, String *field, Obj *term);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Index/PostingList.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Index/PostingList.cfh b/core/Lucy/Index/PostingList.cfh
index 23262ac..d5d80e6 100644
--- a/core/Lucy/Index/PostingList.cfh
+++ b/core/Lucy/Index/PostingList.cfh
@@ -46,7 +46,8 @@ public class Lucy::Index::PostingList nickname PList
     /** Prepare the PostingList object to iterate over matches for documents
      * that match `target`.
      *
-     * @param target The term to match.  If NULL, the iterator will be empty.
+     * @param target The term to match.  If [](cfish:@null), the iterator will
+     * be empty.
      */
     public abstract void
     Seek(PostingList *self, Obj *target = NULL);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Index/PostingListReader.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Index/PostingListReader.cfh b/core/Lucy/Index/PostingListReader.cfh
index b09c372..cb8fac8 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 `field` is NULL or
-     * `field` is not present in any documents.
+    /** Returns a PostingList, or [](cfish:@null) if either `field` is
+     * [](cfish:@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
@@ -43,8 +43,8 @@ public class Lucy::Index::PostingListReader nickname PListReader
     abstract LexiconReader*
     Get_Lex_Reader(PostingListReader *self);
 
-    /** Returns NULL since PostingLists may only be iterated at the segment
-     * level.
+    /** Returns [](cfish:@null) since PostingLists may only be iterated at the
+     * segment level.
      */
     public incremented nullable PostingListReader*
     Aggregator(PostingListReader *self, VArray *readers, I32Array *offsets);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Index/Segment.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Index/Segment.cfh b/core/Lucy/Index/Segment.cfh
index a9f5ded..fc6d8bb 100644
--- a/core/Lucy/Index/Segment.cfh
+++ b/core/Lucy/Index/Segment.cfh
@@ -97,8 +97,8 @@ public class Lucy::Index::Segment nickname Seg inherits Clownfish::Obj {
     public int32_t
     Field_Num(Segment *self, String *field);
 
-    /** Given a field number, return the name of its field, or NULL if the
-     * field name can't be found.
+    /** Given a field number, return the name of its field, or [](cfish:@null)
+     * if the field name can't be found.
      */
     public nullable String*
     Field_Name(Segment *self, int32_t field_num);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Index/Snapshot.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Index/Snapshot.cfh b/core/Lucy/Index/Snapshot.cfh
index 1e18cda..89b0de9 100644
--- a/core/Lucy/Index/Snapshot.cfh
+++ b/core/Lucy/Index/Snapshot.cfh
@@ -81,9 +81,9 @@ public class Lucy::Index::Snapshot inherits Clownfish::Obj {
      * already exists.
      *
      * @param folder A Folder.
-     * @param path The path of the file to write.  If NULL, a file name will
-     * be chosen which supersedes the latest snapshot file in the index
-     * folder.
+     * @param path The path of the file to write.  If [](cfish:@null), a file
+     * name will be chosen which supersedes the latest snapshot file in the
+     * index folder.
      */
     public void
     Write_File(Snapshot *self, Folder *folder, String *path = NULL);
@@ -94,8 +94,8 @@ public class Lucy::Index::Snapshot inherits Clownfish::Obj {
     public void
     Set_Path(Snapshot *self, String *path);
 
-    /** Get the path to the snapshot file.  Initially NULL; updated by
-     * [](cfish:.Read_File), [](cfish:.Write_File), and [](cfish:.Set_Path).
+    /** Get the path to the snapshot file.  Initially [](cfish:@null); updated
+     * by [](cfish:.Read_File), [](cfish:.Write_File), and [](cfish:.Set_Path).
      */
     public nullable String*
     Get_Path(Snapshot *self);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Plan/Schema.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Plan/Schema.cfh b/core/Lucy/Plan/Schema.cfh
index 3f3f415..d4f4632 100644
--- a/core/Lucy/Plan/Schema.cfh
+++ b/core/Lucy/Plan/Schema.cfh
@@ -60,7 +60,7 @@ public class Lucy::Plan::Schema inherits Clownfish::Obj {
     Spec_Field(Schema *self, String *name, FieldType *type);
 
     /** Return the FieldType for the specified field.  If the field can't be
-     * found, return NULL.
+     * found, return [](cfish:@null).
      */
     public nullable FieldType*
     Fetch_Type(Schema *self, String *field);
@@ -70,8 +70,9 @@ public class Lucy::Plan::Schema inherits Clownfish::Obj {
     nullable Analyzer*
     Fetch_Analyzer(Schema *self, String *field = NULL);
 
-    /** Return the Similarity for the specified field, or NULL if either the
-     * field can't be found or it isn't associated with a Similarity.
+    /** Return the Similarity for the specified field, or [](cfish:@null) if
+     * either the field can't be found or it isn't associated with a
+     * Similarity.
      */
     public nullable Similarity*
     Fetch_Sim(Schema *self, String *field = NULL);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Search/Compiler.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Search/Compiler.cfh b/core/Lucy/Search/Compiler.cfh
index 1a79b2c..d474674 100644
--- a/core/Lucy/Search/Compiler.cfh
+++ b/core/Lucy/Search/Compiler.cfh
@@ -79,8 +79,8 @@ public class Lucy::Search::Compiler inherits Lucy::Search::Query {
      *
      * @param reader A SegReader.
      * @param need_score Indicate whether the Matcher must implement [](cfish:Matcher.Score).
-     * @return a Matcher, or NULL if the Matcher would have matched no
-     * documents.
+     * @return a Matcher, or [](cfish:@null) if the Matcher would have matched
+     * no documents.
      */
     public abstract incremented nullable Matcher*
     Make_Matcher(Compiler *self, SegReader *reader, bool need_score);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Search/Hits.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Search/Hits.cfh b/core/Lucy/Search/Hits.cfh
index d3a9bf5..fa8400a 100644
--- a/core/Lucy/Search/Hits.cfh
+++ b/core/Lucy/Search/Hits.cfh
@@ -34,7 +34,7 @@ public class Lucy::Search::Hits inherits Clownfish::Obj {
     init(Hits *self, Searcher *searcher, TopDocs *top_docs,
          uint32_t offset = 0);
 
-    /** Return the next hit, or NULL when the iterator is exhausted.
+    /** Return the next hit, or [](cfish:@null) when the iterator is exhausted.
      */
     public incremented nullable HitDoc*
     Next(Hits *self);

http://git-wip-us.apache.org/repos/asf/lucy/blob/750dcb6f/core/Lucy/Search/QueryParser.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Search/QueryParser.cfh b/core/Lucy/Search/QueryParser.cfh
index 967e7db..4c1f1a6 100644
--- a/core/Lucy/Search/QueryParser.cfh
+++ b/core/Lucy/Search/QueryParser.cfh
@@ -78,7 +78,7 @@ public class Lucy::Search::QueryParser nickname QParser
     /** Build a Query object from the contents of a query string.  At present,
      * implemented internally by calling [](cfish:.Tree), [](cfish:.Expand), and [](cfish:.Prune).
      *
-     * @param query_string The string to be parsed.  May be NULL.
+     * @param query_string The string to be parsed.  May be [](cfish:@null).
      * @return a Query.
      */
     public incremented Query*


Mime
View raw message