docs(cpp): API reference main#50
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (26)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
area:content
Auto-PR #50 (cpp) merged first and added the C++ subgroup to docs.json's Generated Package References. Rebasing #49 (rust) over that produced a docs.json conflict. Resolve by re-running scripts/splice-sdk-nav.py, which is the canonical local splicer. Discovered while resolving that the script only knew about TS/Python/.NET, so adding Rust + C++ to its lang_specs at the same time. Without that, every local splice run would silently drop Rust + C++ subgroups.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive auto-generated C++ API documentation for the ResQ SDK, covering a wide range of modules including common utilities (ArrayUtils, FileUtils, StringUtils), geospatial tools (GeoPoint, NoFlyZone), and various data structures (BloomFilter, Graph, Trie). The review feedback identifies several issues in the generated output that should be addressed at the source-level XML documentation or within the generator logic to ensure persistence. Key issues include broken Markdown links due to special characters, invalid C++ code in examples caused by embedded link syntax, redundant license headers, structural errors in documentation sections, missing method descriptions, and the use of filenames that are not URL-friendly.
| | [`ArrayUtils`](./resq-ArrayUtils.md#arrayutils) | Fast operations on sorted uint32_t arrays. | | ||
| | [`FileHandle`](./resq-FileHandle.md#filehandle) | RAII file handle that ensures closure. | | ||
| | [`Result`](./resq-Result.md#result) | [Result](./resq-Result.md#result) type representing either success (Ok) or failure (Err) | | ||
| | [`Result< void >`](resq-Result( void ).md#resultvoid) | Specialization for void (operation succeeded with no return value) | |
There was a problem hiding this comment.
The Markdown link for Result< void > is broken because the URL contains spaces and parentheses. Please apply the fix (wrapping the URL in angle brackets <...> in the link part) to the source-level XML documentation instead of this generated file to ensure the fix persists across regeneration cycles.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| uint32_t assigned[] = {2, 3, 4, 5}; | ||
|
|
||
| uint32_t* free_drones = nullptr; | ||
| size_t count = [ArrayUtils::exclude_scalar](#exclude_scalar)(available, 5, assigned, 4, &free_drones); |
There was a problem hiding this comment.
Markdown link syntax [Text](#anchor) is used inside a C++ code block, which results in invalid C++ code. Please remove this link syntax from the source-level XML documentation to ensure the generated example is valid and copy-pasteable.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at | ||
| ``` | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| ``` | ||
| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
There was a problem hiding this comment.
The license header is repeated multiple times throughout this file. This appears to be an artifact of the documentation generator. Please apply a fix to the generator logic or the source files rather than this generated file, as per repository rules for auto-generated documentation.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| #### Returns | ||
| true if element possibly exists, false if definitely not exists | ||
|
|
||
| #### Parameters |
There was a problem hiding this comment.
The #### Parameters header is incorrectly placed inside the Returns section. Please correct this structural error in the source-level XML doc comments rather than editing this generated file.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| | `void` | [`split_respecting_quotes`](#split_respecting_quotes) `static` `inline` | Split keeping quoted sections intact. | | ||
| | `std::string` | [`remove_whitespace`](#remove_whitespace) `static` `inline` | Remove all whitespace from string. | | ||
| | `std::string` | [`pad_left`](#pad_left) `static` `inline` | Pad string to width with fill character. | | ||
| | `std::string` | [`pad_right`](#pad_right) `static` `inline` | | |
There was a problem hiding this comment.
The description for pad_right is missing in the summary table. Please add the missing documentation to the source-level XML doc comments to ensure it persists in future builds.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| | `std::vector< uint32_t >` | [`union_of`](#union_of) `static` `inline` | Union of two vectors (returns new vector) | | ||
| | `std::vector< uint32_t >` | [`exclude`](#exclude) `static` `inline` | Exclude elements (a - b) (returns new vector) | | ||
| | `bool` | [`contains`](#contains) `static` `inline` | Check if element exists in sorted array. | | ||
| | `bool` | [`contains`](#contains-1) `static` `inline` | | |
There was a problem hiding this comment.
The description for the vector-based contains method is missing in the summary table. Please add the missing documentation to the source-level XML doc comments.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| @@ -0,0 +1,165 @@ | |||
| ## Result< void > | |||
There was a problem hiding this comment.
The filename resq-Result( void ).md contains spaces and parentheses, which can lead to broken links and issues with URL routing. Please update the source entity name or the generator configuration to produce a URL-friendly filename like resq-Result-void.md.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
2 participants
Auto-generated by
API docs (C++)inresq-software/vcpkgfor refmain(run: 25620166260).
Regenerated files under
sdks/cpp/api/. Doxygen extracteddeclarations from each package's
include/headers; moxygenconverted them to Markdown.