doxygen

    0热度

    1回答

    我有一个库,使用在更大的项目中使用的doxygen进行记录。 我对我的图书馆有一个很好的\ mainpage,当我在更大的项目上运行doxygen时,我希望将其降级到\ page。有没有简单的方法来做到这一点,而不依赖于Doxygen安装的工具以外的工具?为了说明,在以其自身运行磁带库的doxygen时的doxygen应该看到: /** \mainpage \section main_in

    0热度

    1回答

    我想记录测试用例由多个文件组成一个单独的降价文件: tests/test_a/ file1 file2 test_a.md 但是,文件test_a.md(其中包括用于测试的Doxygen文档)现在显示在Doxygen的“相关页面”标签中,如果您有很多测试,这很烦人。有什么办法可以防止这种情况发生?

    0热度

    2回答

    对于我的doxygen(doxypy)文档,我收到错误消息warning: Member constant1 (variable) of namespace <file_name> is not documented.。我已经记录了该文件以及所有功能和类。但我也有一些额外的常量在这个文件中,我不知道如何记录和我得到的错误信息。该文件是这样的: """\file \brief <this is w

    3热度

    1回答

    我正在使用@JSDoc为我的JavaScript库创建文档。我知道如何表示可选参数。像下面一样 /* * @param {string} [somebody] - Somebody's name. */ function sayHello(somebody) { if (!somebody) { somebody = 'John Doe'; } al

    3热度

    2回答

    我在翻译我的C++库并使用Doxygen编写了一个很好的文档。假设我声明了类型: typedef enum { NO_ERROR, ///< Everything fine. SOME_REALLY_BAD_ERROR, ///< Something went wrong. VERY_INFREQUENT_ERROR ///< Used only in some

    0热度

    1回答

    我想在windows中为visual studio 2010安装doxygen插件。其次本文 Minutes-to-document-your-code 中给出的步骤,但是,当我在doxygen的点击窗口下它说没有找到配置文件default.doxygen。

    3热度

    1回答

    此问题是由于doxygen解析约束。我在Kinetis Design Studio中为嵌入式C开发使用了doxygen 1.8.11和Eclox(eclipse插件)。 几乎所有的doxygen编译工作,除了我需要有一些非常大的静态数组。我不想弄乱主要的代码,所以我用了一个劈我这些论坛上找到(https://stackoverflow.com/a/4645515/6776259): static

    0热度

    2回答

    的extern API欲记录在头文件一个extern API如下 // bar.h #ifdef __cplusplus extern "C" { #endif /** * \memberof bar * This is foo */ extern int foo(); #define JUNK_A DONT_DOC_IT #define JUNK_B DONT_DOC_

    4热度

    1回答

    我找不到任何有关javadoc参数中是否有多行信息的信息。我正在制作一个国际象棋引擎,我希望能够解析一个字符串来生成一个棋盘。如下所示,可以这样做吗? /** * Creates a board based on a string. * @param boardString The string to be parsed. Must be of the format: * "8x8\n"

    0热度

    1回答

    我试图在Doxygen中跳过#,在我的文档中对一种方法的描述中提出了#####EXAMPLE#####,我看到很多建议,但没有任何作用。然后,我只使用\#,它的工作。除此之外,我在文本前后使用##,并在文本####EXAMPLE####的周围创建了一个新行,一个空格。现在我想知道它是否正确以及Doxygen中究竟意味着什么##。 /*! *\brief *## * \#\#\#\#\#EXA