lucy-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Nick Wellnhofer (JIRA)" <j...@apache.org>
Subject [lucy-issues] [jira] [Resolved] (LUCY-290) Review generated C API documentation
Date Fri, 26 Feb 2016 11:50:18 GMT

     [ 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)

Mime
View raw message