albert-github opened a new issue #20010: URL: https://github.com/apache/incubator-mxnet/issues/20010
## Description This is a documentation bug report regarding the use of `\param` In the file https://github.com/apache/incubator-mxnet/blob/master/include/mxnet/c_api.h around line 1337: ``` /*! * \brief compute the gradient of outputs w.r.t variabels * \param num_output number of output NDArray * \param output_handles output NDArrays * \param ograd_handles head gradient for NDArrays * \param num_variables number of variables * \param * \param retain_graph whether to keep the graph after backward * \param is_train whether to do backward for training or inference * \return 0 when success, -1 when failure happens */ ``` resulting in:  Another issue is a bit an empty Note in the same file (multiple times, might also be the case in other files) e.g. around line 337: ``` /*! * \brief Deprecated, use MXAggregateProfileStatsPrintEx instead. * \param out_str Will receive a pointer to the output string * \param reset Clear the aggregate stats after printing * \return 0 when success, -1 when failure happens. * \note */ MXNET_DLL int MXAggregateProfileStatsPrint(const char **out_str, int reset); ``` Resulting in:  Remark: doxygen also has the `\deprecated` command: > \deprecated { description } > > Starts a paragraph indicating that this documentation block belongs to a deprecated entity. Can be used to describe alternatives, expected life span, etc. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@mxnet.apache.org For additional commands, e-mail: issues-h...@mxnet.apache.org
