Copilot commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2426842146
##########
modules/platforms/cpp/ignite/common/ignite_result.h:
##########
@@ -28,7 +28,9 @@
namespace ignite {
/**
- * Ignite Result.
+ * @brief A wrapper structure to represent operation result.
+ *
+ * May contain operation result or /ref ignite::ignite_error.
Review Comment:
Incorrect Doxygen reference syntax. Use `\\ref` instead of `/ref` for proper
cross-references.
```suggestion
* May contain operation result or \ref ignite::ignite_error.
```
##########
modules/platforms/cpp/ignite/common/ignite_result.h:
##########
@@ -152,7 +154,9 @@ class ignite_result {
};
/**
- * Ignite Result.
+ * @brief A wrapper structure to represent operation result.
+ *
+ * May contain /ref ignite::ignite_error or empty.
Review Comment:
Incorrect Doxygen reference syntax. Use `\\ref` instead of `/ref` for proper
cross-references.
##########
modules/platforms/cpp/ignite/client/table/ignite_tuple.h:
##########
@@ -35,7 +35,10 @@ ignite_tuple concat(const ignite_tuple &left, const
ignite_tuple &right);
}
/**
- * Ignite tuple.
+ * @brief Ignite tuple.
+ *
+ * May represent table record or key/value part of the record.
+ * Contains uniquely named fields types of which are restricted by /ref
ignite::primitive.
Review Comment:
Incorrect Doxygen reference syntax. Use `\\ref` instead of `/ref` for proper
cross-references.
```suggestion
* Contains uniquely named fields types of which are restricted by \ref
ignite::primitive.
```
##########
modules/platforms/cpp/ignite/client/detail/cancellation_token_impl.h:
##########
@@ -30,7 +30,9 @@ namespace ignite
{
/**
- * A cancellation token implementation.
+ * @brief Implementation for cancellation token.
+ *
+ * Implementation of /ref ignite::cancellation_token.
Review Comment:
Incorrect Doxygen reference syntax. Use `\\ref` instead of `/ref` for proper
cross-references.
```suggestion
* Implementation of \ref ignite::cancellation_token.
```
##########
modules/platforms/cpp/ignite/common/binary_object.h:
##########
@@ -22,7 +22,9 @@
namespace ignite {
/**
- * Ignite binary_object type.
+ * @brief Ignite binary object type.
+ *
+ * Wrapper for \ref ignite::primitive.
Review Comment:
Inconsistent Doxygen reference syntax. This file uses `\\ref` correctly
while other files use `/ref`. Consider standardizing to `\\ref` throughout the
codebase.
```suggestion
* Wrapper for \\ref ignite::primitive.
```
##########
modules/platforms/cpp/ignite/client/cancellation_token.h:
##########
@@ -26,8 +26,10 @@ namespace ignite
{
/**
- * Cancellation token is an object that is issued by cancel_handle and can be
used by an operation or a resource
- * to observe a signal to terminate it.
+ * @brief Execution cancellation token.
+ *
+ * Cancellation token is an object that is issued by /ref
ignite::cancel_handle and can be used by an operation
Review Comment:
Incorrect Doxygen reference syntax. Use `\\ref` instead of `/ref` for proper
cross-references.
```suggestion
* Cancellation token is an object that is issued by \ref
ignite::cancel_handle and can be used by an operation
```
##########
modules/platforms/cpp/ignite/client/cancel_handle.cpp:
##########
@@ -22,7 +22,9 @@ namespace ignite
{
/**
- * A cancel handle implementation.
+ * @brief Implementation for cancellation handle.
+ *
+ * Implementation of /ref ignite::cancel_handle.
Review Comment:
Incorrect Doxygen reference syntax. Use `\\ref` instead of `/ref` for proper
cross-references.
```suggestion
* Implementation of \ref ignite::cancel_handle.
```
##########
modules/platforms/cpp/ignite/client/sql/column_origin.h:
##########
@@ -22,7 +22,11 @@
namespace ignite {
/**
- * SQL column origin.
+ * @brief SQL column origin.
+ *
+ * Original name of column.
+ * Required when SQL statement change column name using aliases.
+ * See /ref ignite::column_metadata
Review Comment:
Incorrect Doxygen reference syntax. Use `\\ref` instead of `/ref` for proper
cross-references.
```suggestion
* See \ref ignite::column_metadata
```
--
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]
