You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@parquet.apache.org by Uwe Korn <uw...@xhochy.com> on 2016/04/20 08:37:34 UTC

C++: API Documentation Style/Tool

Hello,

I would start to make some API documentation comments in the parquet-cpp 
code I'm currently working on. By default, I would use doxygen and 
doxygen-style comments for the API. Are there any other suggestions/best 
practices you would prefer?

Greetings
Uwe

Re: C++: API Documentation Style/Tool

Posted by Wes McKinney <we...@cloudera.com>.

I am fine with Doxygen style comments. I will make an effort to adopt
this style as well (especially when we set up auto-generated HTML API
documentation pages).

- Wes

On Wed, Apr 20, 2016 at 8:37 AM, Uwe Korn <uw...@xhochy.com> wrote:
> Hello,
>
> I would start to make some API documentation comments in the parquet-cpp
> code I'm currently working on. By default, I would use doxygen and
> doxygen-style comments for the API. Are there any other suggestions/best
> practices you would prefer?
>
> Greetings
> Uwe