Mailing-List: contact dev-help@arrow.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@arrow.apache.org
Date: Wed, 21 Sep 2016 19:55:20 +0000 (UTC)
From: "Uwe L. Korn (JIRA)" <jira@apache.org>
To: dev@arrow.apache.org
Message-ID: <JIRA.12956059.1459837495000.630401.1474487720446@Atlassian.JIRA>
In-Reply-To: <JIRA.12956059.1459837495000@Atlassian.JIRA>
References: <JIRA.12956059.1459837495000@Atlassian.JIRA> <JIRA.12956059.1459837495849@arcas>
Subject: [jira] [Commented] (ARROW-96) C++: API documentation using Doxygen
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
archived-at: Wed, 21 Sep 2016 19:55:22 -0000


    [ https://issues.apache.org/jira/browse/ARROW-96?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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)