This repository was archived by the owner on May 12, 2021. It is now read-only.
Generate Perl POD from public methods#18
Merged
asfgit merged 18 commits intoapache:masterfrom Aug 30, 2015
nwellnhof:perl_pod
Merged
Generate Perl POD from public methods#18asfgit merged 18 commits intoapache:masterfrom nwellnhof:perl_pod
asfgit merged 18 commits intoapache:masterfrom
nwellnhof:perl_pod
Conversation
All public Analyzer methods are now documented in the Perl API: - Transform - TransformText - Split - Load - Dump
Additional Document methods added to the Perl API: - Store - Get_Size - Extract - Field_Names These methods are needed for the C bindings but they aren't really useful from Perl. They can be blacklisted later.
Methods that weren't documented in the Perl bindings are made private.
Methods that weren't documented in the Perl bindings are made private.
Document FieldType setters in Perl bindings. Other Methods that weren't documented are made private.
Methods that weren't documented in the Perl bindings are made private.
Methods that weren't documented in the Perl bindings are made private.
Needed for C bindings.
The Inverter parameter isn't public.
RangeCompiler isn't public.
The DocVector parameter isn't public.
|
Marvin Humphrey on dev@lucy.apache.org replies: I reviewed a diff of the generated POD before and after merging this branch Unsurprisingly for a change of this magnitude, there were a few glitches.
Marvin Humphrey |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Clownfish branch
perl_podadds 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.