You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2017/01/13 18:58:53 UTC
[3/3] arrow git commit: ARROW-96: Add C++ API documentation
ARROW-96: Add C++ API documentation
This adds a basic `Doxyfile` that can be used to generate the HTML API documentation as well as a small, initial "Getting Started".
The documentation is not yet deployed anywhere. We can either also use `readthedocs.org` for this (via the `breathe` package) or wait for the restructuring of the website as discussed on the ML and then add this to the "update website" scripts. I'd personally prefer the latter.
Author: Uwe L. Korn <uw...@xhochy.com>
Closes #271 from xhochy/ARROW-96 and squashes the following commits:
45c98cb [Uwe L. Korn] Add license headers
e7c9849 [Uwe L. Korn] ARROW-96: Add C++ API documentation
Project: http://git-wip-us.apache.org/repos/asf/arrow/repo
Commit: http://git-wip-us.apache.org/repos/asf/arrow/commit/cb83b8d3
Tree: http://git-wip-us.apache.org/repos/asf/arrow/tree/cb83b8d3
Diff: http://git-wip-us.apache.org/repos/asf/arrow/diff/cb83b8d3
Branch: refs/heads/master
Commit: cb83b8d30d6bc7d654736c590763145d7c7252ce
Parents: ad0e57d
Author: Uwe L. Korn <uw...@xhochy.com>
Authored: Fri Jan 13 13:58:45 2017 -0500
Committer: Wes McKinney <we...@twosigma.com>
Committed: Fri Jan 13 13:58:45 2017 -0500
----------------------------------------------------------------------
cpp/README.md | 9 +
cpp/apidoc/.gitignore | 1 +
cpp/apidoc/Doxyfile | 2492 ++++++++++++++++++++++++++++++++++++++++++++
cpp/apidoc/index.md | 85 ++
cpp/src/arrow/array.h | 35 +-
5 files changed, 2610 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/arrow/blob/cb83b8d3/cpp/README.md
----------------------------------------------------------------------
diff --git a/cpp/README.md b/cpp/README.md
index b77ea99..542a854 100644
--- a/cpp/README.md
+++ b/cpp/README.md
@@ -62,6 +62,15 @@ variables
* Hadoop: `HADOOP_HOME` (only required for the HDFS I/O extensions)
* jemalloc: `JEMALLOC_HOME` (only required for the jemalloc-based memory pool)
+### API documentation
+
+To generate the (html) API documentation, run the following command in the apidoc
+directoy:
+
+ doxygen Doxyfile
+
+This requires [Doxygen](http://www.doxygen.org) to be installed.
+
## Continuous Integration
Pull requests are run through travis-ci for continuous integration. You can avoid
http://git-wip-us.apache.org/repos/asf/arrow/blob/cb83b8d3/cpp/apidoc/.gitignore
----------------------------------------------------------------------
diff --git a/cpp/apidoc/.gitignore b/cpp/apidoc/.gitignore
new file mode 100644
index 0000000..5ccff1a
--- /dev/null
+++ b/cpp/apidoc/.gitignore
@@ -0,0 +1 @@
+html/