Skip to content

[XRT DOCS] add xrt::module and xrt::ext APIs to native C++ reference - #10115

Merged
stsoe merged 2 commits into
Xilinx:masterfrom
aktondak:docs-module-ext-apis
Oct 26, 2026
Merged

stsoe merged 2 commits into
Xilinx:masterfrom
aktondak:docs-module-ext-apis

Conversation

@aktondak

@aktondak aktondak commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Problem solved by the commit

Include the module and extension headers in the Doxygen input set and document xrt::module, xrt::ext::bo, and xrt::ext::kernel in the native API guide and class reference so NPU ELF flows match the published docs.

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered

https://jira.xilinx.com/browse/AIESW-29700

How problem was solved, alternative solutions (if any) and why they were rejected

Solved via adding the newer XRT APIs as part of doxygen. For the documentation to be published, we still need to docs to be built once this PR is merged.

Risks (if any) associated the changes in the commit

None

What has been tested and how, request additional testing if necessary

Documentation impact (if any)

Include the module and extension headers in the Doxygen input set and
document xrt::module, xrt::ext::bo, and xrt::ext::kernel in the native
API guide and class reference so NPU ELF flows match the published docs.

Signed-off-by: Akshay Tondak <aktondak@amd.com>
@github-actions

Copy link
Copy Markdown
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@aktondak
aktondak requested a review from stsoe October 15, 2026 17:39
@aktondak
aktondak marked this pull request as ready for review October 15, 2026 17:39
@aktondak
aktondak requested a review from uday610 as a code owner October 15, 2026 17:39
Comment thread src/runtime_src/doc/toc/xrt_native.main.rst Outdated
Keep only xrt::ext::bo and xrt::ext::kernel in the Doxygen input and
native API documentation.

Signed-off-by: Akshay Tondak <aktondak@amd.com>
@github-actions

Copy link
Copy Markdown
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@aktondak
aktondak requested a review from stsoe October 20, 2026 17:28
@stsoe
stsoe merged commit 8ea608b into Xilinx:master Oct 26, 2026
26 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants