You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The documentation of several ROCm projects contains stray #include statements, as seen in rocThrust here:
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.
The text was updated successfully, but these errors were encountered:
Description of errors
The documentation of several ROCm projects contains stray
#include
statements, as seen in rocThrust here: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, withUse Exclude Setting and Ignore Files
turned off.In StreamHPC's GitLab versions of the repositories, these are the number of results:
After I had determined that
doxygengroup
s were the cause, I had started replacing them withdoxygenstruct
s,doxygentypedef
s, 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.The text was updated successfully, but these errors were encountered: