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

Wes McKinney commented on ARROW-1226:
-------------------------------------

Per comments in 
https://github.com/mapd/mapd-core/commit/baf29451aa4bcf78e3bb1c4c5d71fb423f62fbe4#commitcomment-23142337
 it would be good to have some higher level comments to indicate when to use 
the {{RecordBatchStreamWriter}} and when to use the lower level 
{{WriteRecordBatch}} API

> [C++] Improve / correct doxygen function documentation in arrow::ipc
> --------------------------------------------------------------------
>
>                 Key: ARROW-1226
>                 URL: https://issues.apache.org/jira/browse/ARROW-1226
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: C++
>            Reporter: Wes McKinney
>
> In looking over headers I spotted some things in ipc/reader.h and 
> ipc/writer.h that could be improved. All functions and classes should also 
> have {{\brief}} annotations to improve the appearance of the generated 
> documentation



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to