Doxygen中FAQ部分的标签

时间:2011-05-19 14:57:56

标签: documentation doxygen

我正在使用Doxygen,我想创建一个FAQ部分。

您会使用哪些doxygen标签来缩进问题和答案?

/**
@section Section_FAQ Frequently Asked Questions

Question: Why is your FAQ so ugly?

Answer: We are currently working on this issue, we should use some specific doxygen tags; a question has been posted on StackOverflow.
*/

2 个答案:

答案 0 :(得分:2)

Doxygen允许嵌入伪html标签,并将其转换为选定的输出格式。见http://www.doxygen.nl/manual/htmlcmds.html 例如,您可以使用经典的html definition list structure

<DL>
  <DT>
    Question: Why is your FAQ so ugly?
  </DT>
  <DD>
    Answer: We are currently working on this issue, we should use some specific
    doxygen tags; a question has been posted on StackOverflow.
  </DD>
</DL>

然后可以使用css文件微调最终外观。然而,对于Latex输出,它显示在同一行(使用doxygen 1.7.5)。

答案 1 :(得分:0)

您可以使用小节

@subsection SubSection_Q_UglyFAQ Why is your FAQ so ugly?

That question is now outdated. The FAQ is beautifull. The users which wonder this should update their doc.