Repository navigation
Doxygen group by category - #49
Merged
Merged
Conversation
danieltowner
requested review from
omalyshe,
rarutyun and
timmiesmith
and
a balanced review from Copilot
October 16, 2026 09:54
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
25 open findings
basic_mask(const builtin_type&)stores the value… · Newbasic_mask(const builtin_type&)stores the value… · Newbasic_mask(const builtin_type&)stores the value… · Newmask_type::from_builtin(r)with direct construction frombuiltin_type. Unlike… · New__v32hitoautochanges the deduced type to the intrinsic’s return type… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New///doc lines are indented inconsistently compared to surrounding… · New
And 5 more that still need to be addressed.
What changed in this PR
This PR reorganizes the library’s Doxygen documentation into standard/proposal-oriented groups (e.g., C++26 / C++29 paper mappings) and updates the Doxygen configuration accordingly.
Changes:
- Introduces/renames many Doxygen groups across SIMD headers to map APIs to C++26 sections and future proposal papers.
- Updates
Doxyfileto a newer template/config and adds additional documentation-generation options. - Includes a few non-doc code changes (mask construction path in
builtin_operator, and type deduction in an AVX-512 permute helper).
| File | Description |
|---|---|
| test/CMakeLists.txt | Removes a GNU-only compiler flag from the test interface options. |
| include/xvec/x86/x86_impl.hpp | Rewords Doxygen comments and marks saturating ops as internal in x86 impl. |
| include/xvec/x86/permute.hpp | Changes local variable typing for AVX-512 emulation helpers to auto. |
| include/xvec/x86/intrin.hpp | Adds a dedicated Doxygen group for x86 intrinsic wrappers and concepts. |
| include/xvec/simd | Major regrouping of basic_vec docs into C++26/paper-aligned Doxygen groups. |
| include/xvec/generic/generic_impl.hpp | Updates Doxygen group tags and tweaks mask/vector conversion construction. |
| include/xvec/detail/std_utility.hpp | Adds P2964-aligned group docs for enum/std::byte helpers. |
| include/xvec/detail/std_rebind.hpp | Adds P3971-aligned group docs for rebind_cast CPO. |
| include/xvec/detail/std_numeric.hpp | Adds P2956-aligned group docs for saturating arithmetic APIs. |
| include/xvec/detail/std_math.hpp | Splits math docs into C++26 math vs “future extensions” groups and refines docstrings. |
| include/xvec/detail/std_limits.hpp | Adds P4209-aligned group docs for numeric_limits<basic_vec<...>>. |
| include/xvec/detail/std_complex.hpp | Adds C++26 complex-math group docs and moves rounding ops under “future_math”. |
| include/xvec/detail/std_bit.hpp | Adds C++26 bit + proposal-aligned groups (P3772, P4010) and refines docstrings. |
| include/xvec/detail/std_algorithm.hpp | Adds a C++26 algorithms group and updates select documentation. |
| include/xvec/detail/split_concat.hpp | Adds a C++26 creation group for chunking/concatenation utilities. |
| include/xvec/detail/reduce.hpp | Adds a C++26 reductions group and improves reduction docstrings. |
| include/xvec/detail/permute.hpp | Adds a C++26 permutations group and expands docstrings for permute/compress/expand/gather/scatter. |
| include/xvec/detail/operators.hpp | Changes mask result construction in the builtin-operator helper. |
| include/xvec/detail/named_permute.hpp | Adds a P3067-aligned group for named permutation utilities. |
| include/xvec/detail/mask.hpp | Major regrouping of mask docs + adds a builtin-representation constructor and adjusts interop docs. |
| include/xvec/detail/loadstore.hpp | Adds a C++26 load/store group and clarifies docstrings for overload families. |
| include/xvec/detail/iterator.hpp | Adds a C++26 iterator group and expands iterator docstrings. |
| include/xvec/detail/invoke.hpp | Adds a P2929-aligned group for chunked_invoke. |
| include/xvec/detail/core.hpp | Adds C++26 traits / flags groups and aligns some entities to P2964 grouping. |
| Doxyfile | Updates Doxygen config template to a newer version and adds new config keys. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Copilot stopped reviewing on behalf of
danieltowner due to an error
October 16, 2026 11:09
danieltowner
force-pushed
the
doxygen_group_by_category
branch
from
October 20, 2026 10:53
8a9c326 to
c4cdb75
Compare
This change makes it clearer what state each function/variable/concept is in. Valid groups include cpp26_???, cpp29_?? (with either a feature name or a paper number), future_???, and so on. This makes it immediately clear whether a feature is standard, proposed, future, and so on. It also groups related features together (e.g., all components of a paper proposal).
danieltowner
force-pushed
the
doxygen_group_by_category
branch
from
October 21, 2026 18:42
c4cdb75 to
a74e2d9
Compare
rarutyun
reviewed
Oct 22, 2026
| * @see https://wg21.link/P2964 | ||
| * @{ | ||
| */ | ||
| /// @addtogroup cpp29_p2964 |
Contributor
There was a problem hiding this comment.
this is because the group is defined elsewhere.
| # The default value is: NO. | ||
|
|
||
| RECURSIVE = NO | ||
| RECURSIVE = YES |
Contributor
There was a problem hiding this comment.
to make it look not only in include/simd but going deeper to subdirectories
| # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
|
|
||
| PREDEFINED = | ||
| PREDEFINED = "_XVEC_UNARY_MATHS_OP(NAME)=template<detail::math_floating_point _Vp> constexpr detail::deduced_vec_t<_Vp> NAME(const _Vp& v)" \ |
Contributor
There was a problem hiding this comment.
to expand those macro names to something more meaningful.
There was a problem hiding this comment.
🟢 Approval recommended
The remaining findings are minor documentation-category corrections, with no runtime changes or blocking defects identified.
3 open issues
25 resolved since last review
mask_type::from_builtin(r)with direct construction frombuiltin_type. Unlike…basic_mask(const builtin_type&)stores the value…basic_mask(const builtin_type&)stores the value…basic_mask(const builtin_type&)stores the value…__v32hitoautochanges the deduced type to the intrinsic’s return type…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…///doc lines are indented inconsistently compared to surrounding…
And 5 more resolved.
Review effort: Balanced
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.