zeroshade commented on code in PR #34972: URL: https://github.com/apache/arrow/pull/34972#discussion_r1213606997
########## cpp/src/arrow/c/abi.h: ########## @@ -15,10 +15,30 @@ // specific language governing permissions and limitations // under the License. +/// \file abi.h Arrow C-Data Interface +/// +/// The Arrow C-Data interface defines a very small, stable set +/// of C definitions which can be easily copied into any project's +/// source code and vendored to be used for columnar data interchange +/// in the Arrow format. For non-C/C++ languages and runtimes, +/// it should be almost as easy to translate the C definitions into +/// the corresponding C FFI declarations. +/// +/// Applications and libraries can therefore work with Arrow memory +/// without necessarily using the Arrow libraries or reinventing +/// the wheel. Developers can choose between tight integration +/// with the Arrow software project or minimal integration with +/// the Arrow format only. + #pragma once #include <stdint.h> +/// \defgroup Arrow C-Data Interface Review Comment: Makes sense, I've added links to the specs and reduced the detail of the comments. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
