On Thu, Aug 27, 2015 at 4:05 AM, nwellnhof <[email protected]> wrote:
> GitHub user nwellnhof opened a pull request:
>
> https://github.com/apache/lucy/pull/18
>
> Generate Perl POD from public methods
>
> The Clownfish branch `perl_pod` adds POD for public novel methods by
> default, making it possible to remove the POD "whitelists".
>
> This branch also adds Perl documentation for Analyzer, Inversion, and
> Token, which is needed to write custom analyzers. It also removes
> documentation for some methods taking private classes as parameters.
I reviewed a diff of the generated POD before and after merging this branch
(and the corresponding Clownfish branch). A summary of the changes is below my
sig.
Unsurprisingly for a change of this magnitude, there were a few glitches.
These are the ones I think we should to attend to:
* Restore documentation for several methods IndexSearcher inherits
from Searcher. Same with PolySearcher (though it's a less important
class).
* Restore Doc#add_fields.
* IndexReader#offsets became IndexReader#_offsets and should be restored.
* The PostingList methods Next, Advance, and Get_Doc_ID should become
public.
* Restore BitCollector#collect
* Restore ANDQuery#add_child and ORQuery#add_child.
Marvin Humphrey
--------------------------
Analyzer
add
transform
transform_text
dump
load
Inversion
add
new
append
next
reset
Token
add
new
get_text
set_text
get_start_offset
get_end_offset
get_boost
get_pos_inc
get_len
Doc # additions intentional, but add back get_fields
add
get_size
extract
field_names
remove
get_fields
DataWriter # intentional, not a big deal
remove
add_inverted_doc
DocReader # not a big deal
remove
aggregator
IndexReader
add
_offsets
remove
offsets
PostingList
remove
next
get_doc_id
advance
FieldType
add
set_indexed
set_boost
set_stored
set_sortable
ANDQuery
remove
add_child
BitCollector
remove
collect
Compiler
remove
highlight_spans
IndexSearcher
remove
hits
collect
doc_max
doc_freq
fetch_doc
get_schema
ORQuery
remove
add_child
PolyQuery
add
add_child
PolySearcher
remove
hits
doc_max
doc_freq
fetch_doc
get_schema
Query
add
dump
load
SortRule
add
get_type
Lock
add
shared
