Repository navigation
AISPARSE-766: publish rocsparse_handle_create/destroy reference - #12206
Merged
Merged
Conversation
rocsparse_handle_create and rocsparse_handle_destroy were added to the public header with complete Doxygen comments, but no Breathe directive ever referenced them, so they never appeared on the documentation site. Users searching for the stream-ordered handle constructor found nothing. Add the missing doxygenfunction sections to the auxiliary reference, list both functions in the exported-function table, and describe the stream-ordered alternative in the handle management section of the user guide. Co-authored-by: Cursor <cursoragent@cursor.com>
github-actions
Bot
added
documentation
ci:docs-only
YvanMokwinski
approved these changes
Sep 16, 2026
YvanMokwinski
left a comment
YvanMokwinski
left a comment
Contributor
There was a problem hiding this comment.
Thank you for doing this.
✅ All Checks Passed — Ready for Review
📖 Need help? See the Policy FAQ for details on every check and how to fix failures. |
|
🎉 All checks passed! This PR is ready for review. |
kliegeois
changed the title
jsandham
approved these changes
Sep 16, 2026
assistant-librarian Bot
pushed a commit
to ROCm/rocSPARSE
that referenced
this pull request
Sep 16, 2026
AISPARSE-766: publish rocsparse_handle_create/destroy reference (#12206) `rocsparse_handle_create` and `rocsparse_handle_destroy` were added to the public header in #8083 with complete Doxygen comments, but no Breathe directive ever referenced them. Because Breathe only renders functions that are explicitly listed, neither function appears anywhere on the documentation site: a search for `rocsparse_handle_create` on rocm.docs.amd.com returns nothing, and users instead land on `rocsparse_create_handle`, which is a different function with a different signature. This was raised by a user who could not find the documentation. JIRA ID: AISPARSE-766 ## Changes - `docs/reference/auxiliary.rst`: add `doxygenfunction` sections for both functions, with `rocsparse_handle_create_` / `rocsparse_handle_destroy_` labels. Ordering follows the header, so each new function sits next to its older counterpart. - `docs/reference/api.rst`: list both functions in the auxiliary exported-function table. - `docs/how-to/using-rocsparse.rst`: describe the stream-ordered alternative in the handle management section, including the restriction against HIP graph stream capture. Documentation only; no library code is touched. ## Validation Both functions are guarded by `#ifdef ROCSPARSE_WITH_HANDLE_CREATE`, but that does not hide them from Doxygen: the CMake option `ROCSPARSE_ENABLE_HANDLE_CREATE` defaults to `ON`, and #8083 already added the macro to `PREDEFINED` in the Doxyfile. - Ran Doxygen over the tree and confirmed both symbols appear in the generated XML (`rocsparse-auxiliary_8h.xml` and `index.xml`). - Built the three PR RST pages through Breathe. The rendered HTML has heading anchors `#rocsparse-handle-create` and `#rocsparse-handle-destroy`, full signatures `rocsparse_handle_create(rocsparse_handle*, hipStream_t, rocsparse_error*)` and `rocsparse_handle_destroy(rocsparse_handle, rocsparse_error*)`, both names in the exported-function table, and working user-guide links. `origin/develop` still has zero `doxygenfunction` entries for these APIs. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
TheRock Submodule Bump ActivityNewest first
|
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.
rocsparse_handle_createandrocsparse_handle_destroywere added to the public header in #8083 with complete Doxygen comments, but no Breathe directive ever referenced them. Because Breathe only renders functions that are explicitly listed, neither function appears anywhere on the documentation site: a search forrocsparse_handle_createon rocm.docs.amd.com returns nothing, and users instead land onrocsparse_create_handle, which is a different function with a different signature. This was raised by a user who could not find the documentation.JIRA ID: AISPARSE-766
Changes
docs/reference/auxiliary.rst: adddoxygenfunctionsections for both functions, withrocsparse_handle_create_/rocsparse_handle_destroy_labels. Ordering follows the header, so each new function sits next to its older counterpart.docs/reference/api.rst: list both functions in the auxiliary exported-function table.docs/how-to/using-rocsparse.rst: describe the stream-ordered alternative in the handle management section, including the restriction against HIP graph stream capture.Documentation only; no library code is touched.
Validation
Both functions are guarded by
#ifdef ROCSPARSE_WITH_HANDLE_CREATE, but that does not hide them from Doxygen: the CMake optionROCSPARSE_ENABLE_HANDLE_CREATEdefaults toON, and #8083 already added the macro toPREDEFINEDin the Doxyfile.rocsparse-auxiliary_8h.xmlandindex.xml).#rocsparse-handle-createand#rocsparse-handle-destroy, full signaturesrocsparse_handle_create(rocsparse_handle*, hipStream_t, rocsparse_error*)androcsparse_handle_destroy(rocsparse_handle, rocsparse_error*), both names in the exported-function table, and working user-guide links.origin/developstill has zerodoxygenfunctionentries for these APIs.