Fix Doxygen warnings in multiple headers files #11003
Conversation
karthikeyann
added
3 - Ready for Review
Co-authored-by: David Wendt <[email protected]> Co-authored-by: Vyas Ramasubramani <[email protected]>
Codecov Report
@@ Coverage Diff @@
## branch-22.08 #11003 +/- ##
===============================================
Coverage ? 86.33%
===============================================
Files ? 144
Lines ? 22706
Branches ? 0
===============================================
Hits ? 19604
Misses ? 3102
Partials ? 0 Continue to review full report at Codecov.
|
|
I would consider not including |
| /// Are the types same - simply copy elements from [begin, end) to out | ||
| /** | ||
| * @brief No conversion necessary | ||
| * | ||
| * @tparam FromT Source type | ||
| * @tparam ToT Target type | ||
| * @param element Source value | ||
| * @return The converted target value, same as source value | ||
| */ |
There was a problem hiding this comment.
Why don't just combine this?
| * `cudf::testing::Types`. This is a drop in replacement for GTest's | ||
| * `::testing::Types`. In lieu of including `gtest/gtest.h`, include | ||
| * @code ::testing::Types @endcode. In lieu of including `gtest/gtest.h`, include |
There was a problem hiding this comment.
I prefer the hashmarks for inline formatting. Did this fix a warning?
There was a problem hiding this comment.
Yes. Even though it linked correctly with ` in the html page, doxygen still gave a warning that it cannot find this symbol. This change fixed the warning.
There was a problem hiding this comment.
Why using @code tag here for reference? I thought that @ref is more suitable here?
There was a problem hiding this comment.
Since cudf_gtest.hpp is excluded, reference to ::testing::Types is removed.
Co-authored-by: David Wendt <[email protected]>
|
rerun tests |
Co-authored-by: David Wendt <[email protected]>
Co-authored-by: David Wendt <[email protected]>
…doc-fix_warnings17
|
Thank you @davidwendt @PointKernel @ttnghia |
|
@gpucibot merge |
Fixes parts of #9373
added missing documentation to fix doxygen warnings in multiple headers
cudf_test/, nvtext/, cudf_kafka/, ipc.hpp
With this PR, there are zero doxygen warnings!☺️