You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucy.apache.org by "Nick Wellnhofer (JIRA)" <ji...@apache.org> on 2016/02/26 12:50:18 UTC
[lucy-issues] [jira] [Resolved] (LUCY-290) Review generated C API documentation
[ https://issues.apache.org/jira/browse/LUCY-290?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Nick Wellnhofer resolved LUCY-290.
----------------------------------
Resolution: Fixed
> Review generated C API documentation
> ------------------------------------
>
> Key: LUCY-290
> URL: https://issues.apache.org/jira/browse/LUCY-290
> Project: Lucy
> Issue Type: Task
> Components: Documentation
> Reporter: Nick Wellnhofer
> Fix For: 0.5.0
>
>
> 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
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)