Remove Plan POD whitelist Document FieldType setters in Perl bindings. Other Methods that weren't documented are made private.
Project: http://git-wip-us.apache.org/repos/asf/lucy/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy/commit/9a3a96c1 Tree: http://git-wip-us.apache.org/repos/asf/lucy/tree/9a3a96c1 Diff: http://git-wip-us.apache.org/repos/asf/lucy/diff/9a3a96c1 Branch: refs/heads/master Commit: 9a3a96c12b6626483e8e090920763799421b2829 Parents: 8323f97 Author: Nick Wellnhofer <wellnho...@aevum.de> Authored: Thu Aug 20 22:55:52 2015 +0200 Committer: Nick Wellnhofer <wellnho...@aevum.de> Committed: Sun Aug 23 15:02:56 2015 +0200 ---------------------------------------------------------------------- core/Lucy/Plan/Architecture.cfh | 32 +++++++++++++-------------- core/Lucy/Plan/BlobType.cfh | 4 ++-- core/Lucy/Plan/FieldType.cfh | 6 ++--- core/Lucy/Plan/FullTextType.cfh | 6 ++--- core/Lucy/Plan/NumericType.cfh | 4 ++-- core/Lucy/Plan/Schema.cfh | 4 ++-- core/Lucy/Plan/StringType.cfh | 6 ++--- core/Lucy/Test/Plan/TestArchitecture.cfh | 4 ++-- core/Lucy/Test/Search/TestSortSpec.cfh | 2 +- perl/buildlib/Lucy/Build/Binding/Plan.pm | 31 -------------------------- 10 files changed, 34 insertions(+), 65 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Plan/Architecture.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/Architecture.cfh b/core/Lucy/Plan/Architecture.cfh index bfd12ae..28d7619 100644 --- a/core/Lucy/Plan/Architecture.cfh +++ b/core/Lucy/Plan/Architecture.cfh @@ -39,7 +39,7 @@ public class Lucy::Plan::Architecture nickname Arch inherits Clownfish::Obj { * * @param writer A SegWriter. */ - public void + void Init_Seg_Writer(Architecture *self, SegWriter *writer); /** Spawn a LexiconWriter and [](cfish:SegWriter.Register) it with the supplied SegWriter, @@ -47,7 +47,7 @@ public class Lucy::Plan::Architecture nickname Arch inherits Clownfish::Obj { * * @param writer A SegWriter. */ - public void + void Register_Lexicon_Writer(Architecture *self, SegWriter *writer); /** Spawn a PostingListWriter and [](cfish:SegWriter.Register) it with the supplied @@ -56,7 +56,7 @@ public class Lucy::Plan::Architecture nickname Arch inherits Clownfish::Obj { * * @param writer A SegWriter. */ - public void + void Register_Posting_List_Writer(Architecture *self, SegWriter *writer); /** Spawn a DataWriter and [](cfish:SegWriter.Register) it with the supplied SegWriter, @@ -72,7 +72,7 @@ public class Lucy::Plan::Architecture nickname Arch inherits Clownfish::Obj { * * @param writer A SegWriter. */ - public void + void Register_Sort_Writer(Architecture *self, SegWriter *writer); /** Spawn a HighlightWriter and [](cfish:SegWriter.Register) it with the supplied SegWriter, @@ -80,7 +80,7 @@ public class Lucy::Plan::Architecture nickname Arch inherits Clownfish::Obj { * * @param writer A SegWriter. */ - public void + void Register_Highlight_Writer(Architecture *self, SegWriter *writer); /** Spawn a DeletionsWriter and [](cfish:SegWriter.Register) it with the supplied SegWriter, @@ -88,15 +88,15 @@ public class Lucy::Plan::Architecture nickname Arch inherits Clownfish::Obj { * * @param writer A SegWriter. */ - public void + void Register_Deletions_Writer(Architecture *self, SegWriter *writer); /** Initialize a SegReader, registering DataReaders. */ - public void + void Init_Seg_Reader(Architecture *self, SegReader *reader); - /** Spawn a DocReader and [](cfish:SegReader.Register) it with the supplied SegReader. + /** Spawn a DocReader and register it with the supplied SegReader. * * @param reader A SegReader. */ @@ -107,14 +107,14 @@ public class Lucy::Plan::Architecture nickname Arch inherits Clownfish::Obj { * * @param reader A SegReader. */ - public void + void Register_Posting_List_Reader(Architecture *self, SegReader *reader); /** Spawn a SortReader and [](cfish:SegReader.Register) it with the supplied SegReader. * * @param reader A SegReader. */ - public void + void Register_Sort_Reader(Architecture *self, SegReader *reader); /** Spawn a HighlightReader and [](cfish:SegReader.Register) it with the supplied @@ -122,32 +122,32 @@ public class Lucy::Plan::Architecture nickname Arch inherits Clownfish::Obj { * * @param reader A SegReader. */ - public void + void Register_Highlight_Reader(Architecture *self, SegReader *reader); /** Spawn a LexiconReader and [](cfish:SegReader.Register) it with the supplied SegReader. * * @param reader A SegReader. */ - public void + void Register_Lexicon_Reader(Architecture *self, SegReader *reader); /** Spawn a DeletionsReader and [](cfish:SegReader.Register) it with the supplied SegReader. * * @param reader A SegReader. */ - public void + void Register_Deletions_Reader(Architecture *self, SegReader *reader); /** Factory method for creating a new Similarity object. */ - public incremented Similarity* + incremented Similarity* Make_Similarity(Architecture *self); - public int32_t + int32_t Index_Interval(Architecture *self); - public int32_t + int32_t Skip_Interval(Architecture *self); /** Returns true for any Architecture object. Subclasses should override http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Plan/BlobType.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/BlobType.cfh b/core/Lucy/Plan/BlobType.cfh index cd29bd1..524552b 100644 --- a/core/Lucy/Plan/BlobType.cfh +++ b/core/Lucy/Plan/BlobType.cfh @@ -48,10 +48,10 @@ public class Lucy::Plan::BlobType inherits Lucy::Plan::FieldType { incremented Hash* Dump_For_Schema(BlobType *self); - public incremented Hash* + incremented Hash* Dump(BlobType *self); - public incremented BlobType* + incremented BlobType* Load(BlobType *self, Obj *dump); public bool http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Plan/FieldType.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/FieldType.cfh b/core/Lucy/Plan/FieldType.cfh index f20d858..344d41d 100644 --- a/core/Lucy/Plan/FieldType.cfh +++ b/core/Lucy/Plan/FieldType.cfh @@ -135,7 +135,7 @@ public abstract class Lucy::Plan::FieldType nickname FType * @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. */ - public int32_t + int32_t Compare_Values(FieldType *self, Obj *a, Obj *b); /** NULL-safe comparison wrapper which sorts NULLs towards the back. @@ -159,10 +159,10 @@ public abstract class Lucy::Plan::FieldType nickname FType abstract incremented Hash* Dump_For_Schema(FieldType *self); - public abstract incremented Obj* + abstract incremented Obj* Dump(FieldType *self); - public abstract incremented Obj* + abstract incremented Obj* Load(FieldType *self, Obj *dump); /** Compares all common properties. http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Plan/FullTextType.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/FullTextType.cfh b/core/Lucy/Plan/FullTextType.cfh index f793294..933ec9f 100644 --- a/core/Lucy/Plan/FullTextType.cfh +++ b/core/Lucy/Plan/FullTextType.cfh @@ -70,16 +70,16 @@ public class Lucy::Plan::FullTextType inherits Lucy::Plan::TextType { public Analyzer* Get_Analyzer(FullTextType *self); - public incremented Similarity* + incremented Similarity* Make_Similarity(FullTextType *self); incremented Hash* Dump_For_Schema(FullTextType *self); - public incremented Hash* + incremented Hash* Dump(FullTextType *self); - public incremented FullTextType* + incremented FullTextType* Load(FullTextType *self, Obj *dump); public bool http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Plan/NumericType.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/NumericType.cfh b/core/Lucy/Plan/NumericType.cfh index 8c83b4a..905e35b 100644 --- a/core/Lucy/Plan/NumericType.cfh +++ b/core/Lucy/Plan/NumericType.cfh @@ -39,10 +39,10 @@ class Lucy::Plan::NumericType nickname NumType inherits Lucy::Plan::FieldType { incremented Hash* Dump_For_Schema(NumericType *self); - public incremented Hash* + incremented Hash* Dump(NumericType *self); - public incremented NumericType* + incremented NumericType* Load(NumericType *self, Obj *dump); } http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Plan/Schema.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/Schema.cfh b/core/Lucy/Plan/Schema.cfh index 84f48e6..32dbdfa 100644 --- a/core/Lucy/Plan/Schema.cfh +++ b/core/Lucy/Plan/Schema.cfh @@ -97,10 +97,10 @@ public class Lucy::Plan::Schema inherits Clownfish::Obj { public Similarity* Get_Similarity(Schema *self); - public incremented Hash* + incremented Hash* Dump(Schema *self); - public incremented Schema* + incremented Schema* Load(Schema *self, Obj *dump); /** Absorb the field definitions of another Schema, verify compatibility. http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Plan/StringType.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Plan/StringType.cfh b/core/Lucy/Plan/StringType.cfh index a906172..90d1bc6 100644 --- a/core/Lucy/Plan/StringType.cfh +++ b/core/Lucy/Plan/StringType.cfh @@ -39,16 +39,16 @@ public class Lucy::Plan::StringType inherits Lucy::Plan::TextType { public inert incremented StringType* new(); - public incremented Similarity* + incremented Similarity* Make_Similarity(StringType *self); incremented Hash* Dump_For_Schema(StringType *self); - public incremented Hash* + incremented Hash* Dump(StringType *self); - public incremented StringType* + incremented StringType* Load(StringType *self, Obj *dump); public bool http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Test/Plan/TestArchitecture.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Test/Plan/TestArchitecture.cfh b/core/Lucy/Test/Plan/TestArchitecture.cfh index dafd5e7..737519b 100644 --- a/core/Lucy/Test/Plan/TestArchitecture.cfh +++ b/core/Lucy/Test/Plan/TestArchitecture.cfh @@ -29,10 +29,10 @@ class Lucy::Test::Plan::TestArchitecture nickname TestArch inert TestArchitecture* init(TestArchitecture *self); - public int32_t + int32_t Index_Interval(TestArchitecture *self); - public int32_t + int32_t Skip_Interval(TestArchitecture *self); } http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/core/Lucy/Test/Search/TestSortSpec.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Test/Search/TestSortSpec.cfh b/core/Lucy/Test/Search/TestSortSpec.cfh index 8b94bae..1d559da 100644 --- a/core/Lucy/Test/Search/TestSortSpec.cfh +++ b/core/Lucy/Test/Search/TestSortSpec.cfh @@ -37,7 +37,7 @@ class Lucy::Test::Search::TestReverseType inherits Lucy::Plan::Int32Type { init2(TestReverseType *self, float boost = 1.0, bool indexed = true, bool stored = true, bool sortable = false); - public int32_t + int32_t Compare_Values(TestReverseType *self, Obj *a, Obj *b); } http://git-wip-us.apache.org/repos/asf/lucy/blob/9a3a96c1/perl/buildlib/Lucy/Build/Binding/Plan.pm ---------------------------------------------------------------------- diff --git a/perl/buildlib/Lucy/Build/Binding/Plan.pm b/perl/buildlib/Lucy/Build/Binding/Plan.pm index 817b75e..6ddd03a 100644 --- a/perl/buildlib/Lucy/Build/Binding/Plan.pm +++ b/perl/buildlib/Lucy/Build/Binding/Plan.pm @@ -34,8 +34,6 @@ sub bind_all { } sub bind_architecture { - my @exposed = qw( Register_Doc_Writer Register_Doc_Reader ); - my $pod_spec = Clownfish::CFC::Binding::Perl::Pod->new; my $synopsis = <<'END_SYNOPSIS'; package MyArchitecture; @@ -86,7 +84,6 @@ END_SYNOPSIS END_CONSTRUCTOR $pod_spec->set_synopsis($synopsis); $pod_spec->add_constructor( alias => 'new', sample => $constructor, ); - $pod_spec->add_method( method => $_, alias => lc($_) ) for @exposed; my $binding = Clownfish::CFC::Binding::Perl::Class->new( parcel => "Lucy", @@ -126,14 +123,6 @@ END_CONSTRUCTOR } sub bind_fieldtype { - my @exposed = qw( - Get_Boost - Indexed - Stored - Sortable - Binary - ); - my $pod_spec = Clownfish::CFC::Binding::Perl::Pod->new; my $synopsis = <<'END_SYNOPSIS'; my @sortable; @@ -144,7 +133,6 @@ sub bind_fieldtype { } END_SYNOPSIS $pod_spec->set_synopsis($synopsis); - $pod_spec->add_method( method => $_, alias => lc($_) ) for @exposed; my $binding = Clownfish::CFC::Binding::Perl::Class->new( parcel => "Lucy", @@ -177,12 +165,6 @@ sub bind_float64type { } sub bind_fulltexttype { - my @exposed = qw( - Set_Highlightable - Highlightable - Get_Analyzer - ); - my $pod_spec = Clownfish::CFC::Binding::Perl::Pod->new; my $synopsis = <<'END_SYNOPSIS'; my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new( @@ -207,7 +189,6 @@ END_SYNOPSIS END_CONSTRUCTOR $pod_spec->set_synopsis($synopsis); $pod_spec->add_constructor( alias => 'new', sample => $constructor, ); - $pod_spec->add_method( method => $_, alias => lc($_) ) for @exposed; my $binding = Clownfish::CFC::Binding::Perl::Class->new( parcel => "Lucy", @@ -240,17 +221,6 @@ sub bind_int64type { } sub bind_schema { - my @exposed = qw( - Spec_Field - Num_Fields - All_Fields - Fetch_Type - Fetch_Sim - Architecture - Get_Architecture - Get_Similarity - ); - my $pod_spec = Clownfish::CFC::Binding::Perl::Pod->new; my $synopsis = <<'END_SYNOPSIS'; use Lucy::Plan::Schema; @@ -272,7 +242,6 @@ END_SYNOPSIS END_CONSTRUCTOR $pod_spec->set_synopsis($synopsis); $pod_spec->add_constructor( alias => 'new', sample => $constructor, ); - $pod_spec->add_method( method => $_, alias => lc($_) ) for @exposed; my $binding = Clownfish::CFC::Binding::Perl::Class->new( parcel => "Lucy",
