[TIKA-3620] Language detection documentation needs attention

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.1.0
• Fix Version/s: 2.2.0
• Component/s: languageidentifier
• Assignee: Lewis John McGibbney
• Reporter: Lewis John McGibbney
• Created: 15/Dec/21 16:29
• Updated: 17/Dec/21 19:06
• Resolved: 17/Dec/21 19:06

Description

This language identifier/detection suffers from a few problems

1. Clarity is needed on identifier/identification Vs detector/detection. Which is it? The source code says identifier whereas the documentation is nested under detection.
2. The org.apache.tika.language.LanguageIdentifier returns 404. What is this meant to resolve to?
3. Generally speaking the documentation is literally non-existent. I checked the wiki and failed to find anything. I did find some minor documentation but this is also severely lacking. Also note the broken hyperlink.

Some suggestions for improvement

1. Fix the broken hyperlinks.
2. Hyperlink to the existing example namely LanguageDetectorExample.java, LanguageDetectingParser.java and Language.java
3. Hyperlink to the LanguageDetector Javadoc and atleast mention some of the other implementations.