Strange documentation for MXAutogradBackwardEx

[albert-github]

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.

[github-actions[bot]]

Welcome to Apache MXNet (incubating)! We are on a mission to democratize AI, and we are glad that you are contributing to it by opening this issue. Please make sure to include all the relevant context, and one of the @apache/mxnet-committers will be here shortly. If you are interested in contributing to our project, let us know! Also, be sure to check out our guide on contributing to MXNet and our development guides wiki.