gemini-code-assist[bot] commented on code in PR #406:
URL: https://github.com/apache/tvm-ffi/pull/406#discussion_r2683361944
##########
include/tvm/ffi/base_details.h:
##########
@@ -115,22 +114,14 @@
return 0; \
}(); \
static void FnName()
-/// \endcond
-/*!
- * \brief Macro that defines a block that will be called during static
initialization.
- *
- * \code{.cpp}
- * TVM_FFI_STATIC_INIT_BLOCK() {
- * RegisterFunctions();
- * }
- * \endcode
- */
+
Review Comment:
The documentation for `TVM_FFI_STATIC_INIT_BLOCK` has been removed from this
`#else` branch, but it remains in the `__GNUC__` branch (lines 95-103). This
creates an inconsistency. For better maintainability, consider either removing
the documentation from the `__GNUC__` branch as well, or moving the
documentation to a common location outside the `#if`/`#else` blocks so it
applies to both definitions.
##########
include/tvm/ffi/base_details.h:
##########
@@ -115,22 +114,14 @@
return 0; \
}(); \
static void FnName()
-/// \endcond
-/*!
- * \brief Macro that defines a block that will be called during static
initialization.
- *
- * \code{.cpp}
- * TVM_FFI_STATIC_INIT_BLOCK() {
- * RegisterFunctions();
- * }
- * \endcode
- */
+
#define TVM_FFI_STATIC_INIT_BLOCK()
\
TVM_FFI_STATIC_INIT_BLOCK_DEF_(TVM_FFI_STR_CONCAT(__TVMFFIStaticInitFunc,
__COUNTER__), \
TVM_FFI_STR_CONCAT(__TVMFFIStaticInitReg,
__COUNTER__))
+/// \endcond
#endif
-/*!
+/*
Review Comment:
This comment has been changed from a Doxygen-style comment (`/*!`) to a
regular C-style comment (`/*`), which will prevent it from appearing in the
generated documentation. Since `TVM_FFI_DEFINE_DEFAULT_COPY_MOVE_AND_ASSIGN` is
used for public-facing classes, its documentation should likely be public.
Please consider changing this back to `/*!` if this was unintentional.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
