Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C++: API documentation using Doxygen #15514

Closed
asfimport opened this issue Apr 5, 2016 · 4 comments
Closed

C++: API documentation using Doxygen #15514

asfimport opened this issue Apr 5, 2016 · 4 comments
Assignees
Milestone

Comments

@asfimport
Copy link

For the developers using Arrow via C++, we should provide an automatically generated API documentation via doxygen.

Reporter: Uwe Korn / @xhochy
Assignee: Uwe Korn / @xhochy

Note: This issue was originally created as ARROW-96. Please see the migration documentation for further details.

@asfimport
Copy link
Author

Uwe Korn / @xhochy:
Currently we're using // for code comments. As far as I know 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).

@wesm 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.

@asfimport
Copy link
Author

Wes McKinney / @wesm:
/// sounds fine to me. Once we get a docs build up we can start being more diligent about writing API documentation

@asfimport
Copy link
Author

Uwe Korn / @xhochy:
PR: #271

@asfimport
Copy link
Author

Wes McKinney / @wesm:
Issue resolved by pull request 271
#271

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants