Add missing documentation in cudf/types.hpp #10895
Conversation
karthikeyann
added
3 - Ready for Review
cpp/include/cudf/types.hpp
Outdated
| /// @cond FORWARD_DECLARATIONS | ||
| namespace rmm { | ||
| class device_buffer; | ||
| namespace mr { | ||
| class device_memory_resource; | ||
| device_memory_resource* get_current_device_resource(); | ||
| } // namespace mr | ||
| /// @endcond |
There was a problem hiding this comment.
Using @cond to skip this forward declarations by doxygen.
There was a problem hiding this comment.
This is interesting. When and how would we actually enable FORWARD_DECLARATIONS?
There was a problem hiding this comment.
I would think we would never enable it -- so doxygen skips this part -- if I'm understanding this.
https://www.doxygen.nl/manual/commands.html#cmdcond
It appears the label is optional so we could remove if that is less confusing.
Codecov Report
@@ Coverage Diff @@
## branch-22.06 #10895 +/- ##
================================================
+ Coverage 86.30% 86.32% +0.02%
================================================
Files 144 144
Lines 22665 22668 +3
================================================
+ Hits 19560 19569 +9
+ Misses 3105 3099 -6
Continue to review full report at Codecov.
|
cpp/include/cudf/types.hpp
Outdated
| /// @cond FORWARD_DECLARATIONS | ||
| namespace rmm { | ||
| class device_buffer; | ||
| namespace mr { | ||
| class device_memory_resource; | ||
| device_memory_resource* get_current_device_resource(); | ||
| } // namespace mr | ||
| /// @endcond |
There was a problem hiding this comment.
This is interesting. When and how would we actually enable FORWARD_DECLARATIONS?
|
rerun tests |
|
@gpucibot merge |
Fixes parts of #9373
added missing documentation in types.hpp to fix doxygen warnings
fixes 30 warnings