You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ignite.apache.org by "Erixonich (via GitHub)" <gi...@apache.org> on 2025/10/10 04:01:08 UTC
[PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Erixonich opened a new pull request, #6741:
URL: https://github.com/apache/ignite-3/pull/6741
https://issues.apache.org/jira/browse/IGNITE-24417
Thank you for submitting the pull request.
To streamline the review process of the patch and ensure better code quality
we ask both an author and a reviewer to verify the following:
### The Review Checklist
- [ ] **Formal criteria:** TC status, codestyle, mandatory documentation. Also make sure to complete the following:
\- There is a single JIRA ticket related to the pull request.
\- The web-link to the pull request is attached to the JIRA ticket.
\- The JIRA ticket has the Patch Available state.
\- The description of the JIRA ticket explains WHAT was made, WHY and HOW.
\- The pull request title is treated as the final commit message. The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
- [ ] **Design:** new code conforms with the design principles of the components it is added to.
- [ ] **Patch quality:** patch cannot be split into smaller pieces, its size must be reasonable.
- [ ] **Code quality:** code is clean and readable, necessary developer documentation is added if needed.
- [ ] **Tests code quality:** test set covers positive/negative scenarios, happy/edge cases. Tests are effective in terms of execution time and resources.
### Notes
- [Apache Ignite Coding Guidelines](https://cwiki.apache.org/confluence/display/IGNITE/Java+Code+Style+Guide)
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2447626648
##########
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:
Corrected reference syntax from '/ref' to '\\ref'.
```suggestion
* Implementation of \ref ignite::cancel_handle.
```
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "isapego (via GitHub)" <gi...@apache.org>.
isapego merged PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2439748551
##########
modules/platforms/cpp/Doxyfile:
##########
@@ -2903,11 +2903,8 @@ MSCFILE_DIRS =
;INPUT= \
Review Comment:
INPUT is commented out, so these paths are ignored by Doxygen. Remove the semicolon to activate the INPUT list.
```suggestion
INPUT= \
```
##########
modules/platforms/cpp/docs/index.dox:
##########
@@ -0,0 +1,9 @@
+/** \mainpage Apache Ignite C++ client
+Apache Ignite is a distributed database and computing platform designed for high-performance, in-memory data processing.<br>
+It combines in-memory data storage with powerful computing capabilities, enabling real-time analytics and transactional processing.<br>
+Apache Ignite supports SQL, key-value, and ACID-compliant transactions, and can be used as a caching layer, a persistent database, or a compute grid across clusters.<br>
+<br>
+The C++ client for Apache Ignite allows C++ applications to connect to an Ignite cluster and interact with it remotely.<br>
+It provides APIs for performing cache operations, executing SQL queries and compute jobs.<br>
Review Comment:
The term 'cache operations' is Ignite 2.x terminology and is misleading for the current client; consider 'table and key-value operations' to reflect the APIs provided.
```suggestion
It provides APIs for performing table and key-value operations, executing SQL queries and compute jobs.<br>
```
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "Erixonich (via GitHub)" <gi...@apache.org>.
Erixonich commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2455034859
##########
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:
you got it.
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "isapego (via GitHub)" <gi...@apache.org>.
isapego commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2455019598
##########
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:
Let's not mix `'\'` and `'@'`. We already use `'@'` everywhere, so let's use `@ref` and not a `\ref`.
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2418965204
##########
modules/platforms/cpp/docs/index.dox:
##########
@@ -0,0 +1,9 @@
+/** \mainpage Apache Ignite C++ client
+Apache Ignite is a distributed database and computing platform designed for high-performance, in-memory data processing.<br>
+It combines in-memory data storage with powerful computing capabilities, enabling real-time analytics, transactional processing.<br>
Review Comment:
The sentence is incomplete - it mentions 'enabling real-time analytics, transactional processing' but lacks a proper conclusion. Consider completing the thought, for example: 'enabling real-time analytics and transactional processing across distributed systems.'
```suggestion
It combines in-memory data storage with powerful computing capabilities, enabling real-time analytics and transactional processing across distributed systems.<br>
```
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2447644653
##########
modules/platforms/cpp/ignite/client/table/key_value_view.h:
##########
@@ -482,7 +484,9 @@ class key_value_view<ignite_tuple, ignite_tuple> {
};
/**
- * Key-Value view interface provides methods to access table records in form of separate key and value parts.
+ * @brief Key-Value view interface for a table.
Review Comment:
Inconsistent article usage in @brief description. Line 487 uses 'for a table' while line 45 uses 'for table' (without article). Standardize to match line 45: 'Key-Value view interface for table.'
```suggestion
* @brief Key-Value view interface for table.
```
##########
modules/platforms/cpp/ignite/client/compute/job_execution.h:
##########
@@ -33,6 +33,8 @@ class job_execution_impl;
}
/**
+ * @brief Object for controlling job execution flow.
+ *
Review Comment:
Remove trailing whitespace on line 37. The line contains only the comment marker and spaces, which should end immediately after the asterisk.
```suggestion
*
```
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "Erixonich (via GitHub)" <gi...@apache.org>.
Erixonich commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2455048715
##########
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:
done
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] IGNITE-24417 added doxygen main page and refined exclusions [ignite-3]
Posted by "Erixonich (via GitHub)" <gi...@apache.org>.
Erixonich commented on code in PR #6741:
URL: https://github.com/apache/ignite-3/pull/6741#discussion_r2426842269
##########
modules/platforms/cpp/docs/index.dox:
##########
@@ -0,0 +1,9 @@
+/** \mainpage Apache Ignite C++ client
+Apache Ignite is a distributed database and computing platform designed for high-performance, in-memory data processing.<br>
+It combines in-memory data storage with powerful computing capabilities, enabling real-time analytics, transactional processing.<br>
Review Comment:
done
--
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: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org