EnricoMi commented on code in PR #46180:
URL: https://github.com/apache/arrow/pull/46180#discussion_r2054200160
##########
cpp/src/arrow/util/from_json.h:
##########
@@ -32,40 +32,52 @@ namespace arrow {
class Array;
class DataType;
-namespace ipc {
-namespace internal {
-namespace json {
+namespace util {
+/// \defgroup array-from-json Helpers for constructing Arrays from JSON text
+///
+/// These helpers are intended to be used in examples, tests, or for quick
+/// prototyping and are not intended to be used where performance matters.
+///
+/// @{
+
+/// \brief Create an Array from a JSON string
ARROW_EXPORT
Result<std::shared_ptr<Array>> ArrayFromJSON(const std::shared_ptr<DataType>&,
const std::string& json);
+/// \brief Create an Array from a JSON string
ARROW_EXPORT
Result<std::shared_ptr<Array>> ArrayFromJSON(const std::shared_ptr<DataType>&,
std::string_view json);
+/// \brief Create an Array from a JSON string
ARROW_EXPORT
Result<std::shared_ptr<Array>> ArrayFromJSON(const std::shared_ptr<DataType>&,
const char* json);
+/// \brief Create an ChunkedArray from a JSON string
ARROW_EXPORT
Status ChunkedArrayFromJSON(const std::shared_ptr<DataType>& type,
const std::vector<std::string>& json_strings,
std::shared_ptr<ChunkedArray>* out);
+/// \brief Create an DictionaryArray from a JSON string
ARROW_EXPORT
Status DictArrayFromJSON(const std::shared_ptr<DataType>&, std::string_view
indices_json,
std::string_view dictionary_json,
std::shared_ptr<Array>* out);
+/// \brief Create an Scalar from a JSON string
ARROW_EXPORT
Status ScalarFromJSON(const std::shared_ptr<DataType>&, std::string_view json,
std::shared_ptr<Scalar>* out);
+/// \brief Create an DictScalar from a JSON string
ARROW_EXPORT
Status DictScalarFromJSON(const std::shared_ptr<DataType>&, std::string_view
index_json,
std::string_view dictionary_json,
std::shared_ptr<Scalar>* out);
-} // namespace json
-} // namespace internal
-} // namespace ipc
+/// @}
Review Comment:
Is this intentional? what does this mean?
##########
cpp/src/arrow/util/from_json.h:
##########
@@ -32,40 +32,52 @@ namespace arrow {
class Array;
class DataType;
-namespace ipc {
-namespace internal {
-namespace json {
+namespace util {
+/// \defgroup array-from-json Helpers for constructing Arrays from JSON text
+///
+/// These helpers are intended to be used in examples, tests, or for quick
+/// prototyping and are not intended to be used where performance matters.
+///
+/// @{
+
+/// \brief Create an Array from a JSON string
ARROW_EXPORT
Result<std::shared_ptr<Array>> ArrayFromJSON(const std::shared_ptr<DataType>&,
const std::string& json);
+/// \brief Create an Array from a JSON string
ARROW_EXPORT
Result<std::shared_ptr<Array>> ArrayFromJSON(const std::shared_ptr<DataType>&,
std::string_view json);
+/// \brief Create an Array from a JSON string
ARROW_EXPORT
Result<std::shared_ptr<Array>> ArrayFromJSON(const std::shared_ptr<DataType>&,
const char* json);
+/// \brief Create an ChunkedArray from a JSON string
ARROW_EXPORT
Status ChunkedArrayFromJSON(const std::shared_ptr<DataType>& type,
const std::vector<std::string>& json_strings,
std::shared_ptr<ChunkedArray>* out);
+/// \brief Create an DictionaryArray from a JSON string
ARROW_EXPORT
Status DictArrayFromJSON(const std::shared_ptr<DataType>&, std::string_view
indices_json,
std::string_view dictionary_json,
std::shared_ptr<Array>* out);
+/// \brief Create an Scalar from a JSON string
ARROW_EXPORT
Status ScalarFromJSON(const std::shared_ptr<DataType>&, std::string_view json,
std::shared_ptr<Scalar>* out);
+/// \brief Create an DictScalar from a JSON string
Review Comment:
```suggestion
/// \brief Create an DictionaryArray from a JSON string
```
--
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]
