Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation]: Remove stray #includes from docs #1105

Open
MyNameIsTrez opened this issue Jan 21, 2025 · 1 comment
Open

[Documentation]: Remove stray #includes from docs #1105

MyNameIsTrez opened this issue Jan 21, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@MyNameIsTrez
Copy link

MyNameIsTrez commented Jan 21, 2025

Description of errors

The documentation of several ROCm projects contains stray #include statements, as seen in rocThrust here:

Image

From what I found, these only show up in structs and classes that have a description, and are inside of a doxygengroup.

I am pretty sure that this is a bug in either Doxygen, Sphinx, or Breathe. A minimal reproducible example should probably be submitted to one of these three repositories, though I'm not sure which of these three causes the bug.

An easy way to find all occurrences in the repositories is by searching for <em>#include in VS Code, with Use Exclude Setting and Ignore Files turned off.

In StreamHPC's GitLab versions of the repositories, these are the number of results:

  • hipCUB: 0
  • hipRAND: 15
  • rocPRIM: 0
  • rocRAND: 21
  • rocThrust: 108

After I had determined that doxygengroups were the cause, I had started replacing them with doxygenstructs, doxygentypedefs, etc.

This however changes the look of the website (though in my opinion in a good way).

More importantly, it also requires any newly added structs to manually be added to the .rst file, increasing the documentation maintenance burden significantly. This is why I decided to keep the docs as-is, and to write this issue.

@ppanchad-amd ppanchad-amd added the documentation Improvements or additions to documentation label Jan 23, 2025
@ppanchad-amd
Copy link

Hi @MyNameIsTrez. Internal ticket has been created to fix documentation. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants