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

ASF GitHub Bot commented on ARROW-1226:
---------------------------------------

GitHub user wesm opened a pull request:

    https://github.com/apache/arrow/pull/1179

    ARROW-1226: [C++] Docs cleaning in arrow/ipc. Doxyfile fixes, move 
ipc/metadata-internal.h symbols to internal NS

    There were also some compiler warnings with clang-4.0 that I fixed here. 

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/wesm/arrow ARROW-1226

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/arrow/pull/1179.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1179
    
----
commit 7b015632449ff1513587a5900891c8056d6ea0d7
Author: Wes McKinney <[email protected]>
Date:   2017-10-05T21:08:18Z

    Clean up doxygen docs in arrow/ipc. Move metadata-internal.h symbols to 
internal namespace. Fix Doxyfile so that full module paths show in generated 
files, like arrow/ipc/reader.h
    
    Change-Id: I3267fea6e155f1ace3279c6c9383740e955cc9c9

----


> [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
>            Assignee: Wes McKinney
>              Labels: pull-request-available
>             Fix For: 0.8.0
>
>
> 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