Doxygen命令段(悬挂)缩进限制?

时间:2014-09-10 14:22:32

标签: c++ doxygen indentation restrictions

对多行(段落)命令可以使用多少缩进有限制吗?

在函数的上下文中考虑@details的典型用例:

/**
 * @brief Do foo.
 * @details Lorem ipsum dolor sit amet, mentitum rationibus nec an.
 *          Usu magna eirmod et, aperiri discere volumus pri ex.
 *
 *          Te pro alii vidit, cu nonumes mediocritatem duo.
 *          Paulo detracto tincidunt id vim, ad has oblique percipit.
 *
 * @tparam T The argument type.
 * @param param1 The first parameter.
 * @param param2 The second parameter.
 * @return The return value.
 */
 template< typename T >
 inline
 T foo( T const& param1, T const& param2 );

必须包含长@details段,这导致了这个缩进是否有任何限制的问题?

我知道Doxygen使用Markdown,它具有特定的缩进限制/用途,例如代码块的“4 space indentation”。如果我想插入代码,上面的缩进会不会混淆或冲突?

更一般地说,是否还有其他缩进用法以及我不知道的可能的冲突?

@ thomas-matthews,这是一个关于技术限制的问题,而不是审美风格

1 个答案:

答案 0 :(得分:0)

非常粗略的建议,但这对我有用-

/**
 * @brief Do foo.
 * @details Lorem ipsum dolor sit amet, mentitum rationibus nec an.
 *
 * &nbsp; &nbsp; &nbsp; &nbsp; Usu magna eirmod et, aperiri discere volumus pri ex.
 * &nbsp; &nbsp; &nbsp; &nbsp; 
 * &nbsp; &nbsp; &nbsp; &nbsp; Te pro alii vidit, cu nonumes mediocritatem duo.
 * &nbsp; &nbsp; &nbsp; &nbsp; Paulo detracto tincidunt id vim, ad has oblique percipit.
 *
 * @tparam T The argument type.
 * @param param1 The first parameter.
 * @param param2 The second parameter.
 * @return The return value.
 */