尝试使用doxygen记录与二维相关的对象

Question

我正在研究一些2D几何代码，特别是一个线类。我做了一个enum来描述线的关系（让我们不详细讨论这个）。但是为了记录这个，我有这样的事情：

enum enumRELATION {

   /*!this line  #######
    * other line -------
    *                   
    *     |             
    *  #######          
    *     |             
    *     |             
    */
   RELATION_INTERSECT,

   ...

};

如果我让doxygen解析该文件，生成一个HTML文件，在HTML文件中，这看起来像垃圾（当然）。换句话说，我试图展示的2D平面都是错误的。我知道我可以使用<br>，至少可以获得换行符，但这只是故事的一半，因为空格仍然不正确。并且<br>使我在实际的源/头文件中的文档看起来很糟糕。这有什么好办法吗？还是我太苛刻了？

Answer 1

您可以使用<pre> ... </pre>元素包围您的文档，这应该很好地保留您的换行符和缩进。

根据这个页面，pre是可以在Doxygen文档中安全使用的HTML标记之一：http://www.doxygen.nl/manual/htmlcmds.html

或者，您可以使用\ image命令将图像嵌入到文档中：http://www.doxygen.nl/manual/commands.html#cmdimage

我相信使用正确的图像可能会比使用'ascii art'更清楚地理解文档;）