[Docs][C++] Fix documentation directive for ChunkLocation #44506
Assignees
Milestone
Comments
amoeba
added a commit
that referenced
this issue
Oct 23, 2024
…44505) ### Rationale for this change Since ChunkLocation is a typedef/alias, it needs to use the `doxygentypedef` Sphinx directive rather than `doxygenstruct` in order for it to show up in the generated HTML. Otherwise we get an error. ### What changes are included in this PR? Just docs: - Replace `doxygenstruct` directive with `doxygentypedef` - Remove `:members:` directive as it's not needed ### Are these changes tested? Yes. ### Are there any user-facing changes? Yes, though just docs. * GitHub Issue: #44506 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
|
Issue resolved by pull request 44505 |
amoeba
added a commit
that referenced
this issue
Nov 11, 2024
…44505) ### Rationale for this change Since ChunkLocation is a typedef/alias, it needs to use the `doxygentypedef` Sphinx directive rather than `doxygenstruct` in order for it to show up in the generated HTML. Otherwise we get an error. ### What changes are included in this PR? Just docs: - Replace `doxygenstruct` directive with `doxygentypedef` - Remove `:members:` directive as it's not needed ### Are these changes tested? Yes. ### Are there any user-facing changes? Yes, though just docs. * GitHub Issue: #44506 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug, including details regarding any error messages, version, and platform.
#44357 was merged yesterday and I noticed when building the docs locally that we get an error related to the particular Sphinx directive we used for ChunkLocation:
ChunkLocation is a typedef/alias so it should use the
doxygentypedefdirective to be properly documented.I originally filed a a minor PR for this, #44505, but am now creating an issue and updating the PR so we can track this alongside #34535 as a backport candidate (i.e., they should be cherry-picked together).
Component(s)
C++, Documentation
The text was updated successfully, but these errors were encountered: