Skip to content

Commit a0b2ecf

Browse files
committed
Fix doxygen
Use `\return` not `\returns`
1 parent b87ce12 commit a0b2ecf

File tree

3 files changed

+3
-5
lines changed

3 files changed

+3
-5
lines changed

cpp/src/arrow/flight/sql/odbc/odbc_api.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,7 @@ SQLRETURN SQLFetch(SQLHSTMT stmt) {
830830
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(stmt);
831831

832832
// The SQL_ATTR_ROW_ARRAY_SIZE statement attribute specifies the number of rows in the
833-
// rowset.
833+
// rowset. Retrieve it with GetArraySize.
834834
ODBCDescriptor* ard = statement->GetARD();
835835
size_t rows = static_cast<size_t>(ard->GetArraySize());
836836

cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ class ODBCStatement : public ODBCHandle<ODBCStatement> {
5858
void ExecutePrepared();
5959
void ExecuteDirect(const std::string& query);
6060

61-
/**
62-
* @brief Returns true if the number of rows fetch was greater than zero.
63-
*/
61+
/// \brief Return Returns true if the number of rows fetch was greater than zero.
6462
bool Fetch(size_t rows);
6563
bool IsPrepared() const;
6664

cpp/src/arrow/flight/sql/odbc/odbc_impl/spi/result_set.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class ResultSet {
8989
/// \param buffer Target buffer to be populated.
9090
/// \param buffer_length Target buffer length.
9191
/// \param strlen_buffer Buffer that holds the length of value being fetched.
92-
/// \returns SQLRETURN for SQLGetData.
92+
/// \return SQLRETURN for SQLGetData.
9393
virtual SQLRETURN GetData(int column, int16_t target_type, int precision, int scale,
9494
void* buffer, size_t buffer_length,
9595
ssize_t* strlen_buffer) = 0;

0 commit comments

Comments
 (0)