Doxygen命令段落(挂起)缩进限制

Doxygen command paragraph (hanging) indentation limitations?

本文关键字:缩进 挂起 命令 段落 Doxygen      更新时间:2023-10-16

多行(段落)命令的缩进量有限制吗?

考虑函数上下文中@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空格缩进"。在我想要插入代码的情况下,上面的缩进会混淆或冲突吗?

更普遍地说,是否还有我不知道的其他缩进用法和可能的冲突?

@托马斯·马修斯,这是一个关于技术限制的问题,而不是美学风格

非常粗糙的建议,但这对我来说是有效的-

/**
 * @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.
 */