[OPENNLP-32] Write more documentation for the parser

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Documentation
• Labels: help-wanted
• Assignee: Unassigned
• Reporter: Joern Kottmann
• Created: 14/Dec/10 17:16
• Updated: 04/Jul/19 17:26

Description

Write more documentation for the parser. It should cover the same topic as the
documentation for the other components.

The following sections are still missing:

• No general introduction, it should be explained what parsing is, ideally with a few images
  of parse trees
• Explain how to navigate in the parse tree with the Parse class, that should be
  explained based on a sample parse tree
• Add a section about how the training api can be used
• Remove all todos, and open jira issues for them if they are not solved with this issue

Issue Links

• links to: GitHub Pull Request #359