[LUCY-290] Review generated C API documentation

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.5.0
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Nikolas Wellnhofer
• Created: 06/Feb/16 18:04
• Updated: 26/Feb/16 11:49
• Resolved: 26/Feb/16 11:49

Description

The current state of the C API documentation can be reviewed here:

https://rawgit.com/nwellnhof/lucy/generated_docs/c/autogen/share/doc/clownfish/lucy.html

There a few things that need to be fixed, especially regarding constructors. For example, both new and init need DocuComments. Then there are some minor mistakes like mixing up documentation for init and init2 of FullTextType:

https://rawgit.com/nwellnhof/lucy/generated_docs/c/autogen/share/doc/clownfish/Lucy/Plan/FullTextType.html