我可以使用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
 */