[jira] [Commented] (ARROW-96) C++: API documentation using Doxygen

2017-01-06 Thread Uwe L. Korn (JIRA)

[ 
https://issues.apache.org/jira/browse/ARROW-96?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15805024#comment-15805024
 ] 

Uwe L. Korn commented on ARROW-96:
--

PR: https://github.com/apache/arrow/pull/271

> C++: API documentation using Doxygen 
> -
>
> Key: ARROW-96
> URL: https://issues.apache.org/jira/browse/ARROW-96
> Project: Apache Arrow
>  Issue Type: Task
>  Components: C++
>Reporter: Uwe L. Korn
>Assignee: Uwe L. Korn
>
> For the developers using Arrow via C++, we should provide an automatically 
> generated API documentation via doxygen.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Commented] (ARROW-96) C++: API documentation using Doxygen

2016-09-21 Thread Uwe L. Korn (JIRA)

[ 
https://issues.apache.org/jira/browse/ARROW-96?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15510985#comment-15510985
 ] 

Uwe L. Korn commented on ARROW-96:
--

Currently we're using {{//}} for code comments. As far as I known doxygen, code 
comments that should be included in the API docs should have a more "special" 
comment, e.g. {{///}} or {{/** */}} (see 
https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html).

[~wesmckinn] I'm happy with any of them. You had some preference if I remember 
correctly? I would also use the same choice then for parquet-cpp.

> C++: API documentation using Doxygen 
> -
>
> Key: ARROW-96
> URL: https://issues.apache.org/jira/browse/ARROW-96
> Project: Apache Arrow
>  Issue Type: Task
>  Components: C++
>Reporter: Uwe L. Korn
>Assignee: Uwe L. Korn
>
> For the developers using Arrow via C++, we should provide an automatically 
> generated API documentation via doxygen.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)