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