doxygen - 我可以使用 doxygen 的 @return 命令进行表格布局吗？

Question

doxygen 命令的输出中是否可以有某种形式的表格布局@return？

/**
 * @return error code,
 *         @ref E_INSUFFICIENT_BUFFER_SIZE if @c bufsize is too small,
 *         @ref E_INSUFFICIENT_ARRAY_SIZE  if @c arrsize is too small
 */

在 HTML 输出中显示为一行：

错误代码，如果 bufsize 太小，则为 E_INSUFFICIENT_BUFFER_SIZE，如果 arrsize 太小，则为 E_INSUFFICIENT_ARRAY_SIZE

Answer 1

您的解决方案可能在于使用破折号。

/**
 * @return error code,
 *        - @ref E_INSUFFICIENT_BUFFER_SIZE if @c bufsize is too small,
 *        - @ref E_INSUFFICIENT_ARRAY_SIZE  if @c arrsize is too small
 */