如何在Doxygen中包含自定義文件

我想添加自定義（非項目）文件以生成Doxygen的一些額外頁面。如何在Doxygen中包含自定義文件

我（實際上）不確定應如何命名這些文件以及如何對其內容進行格式化。

2010-06-16 Veger

在找到答案之前，我一直在尋找很多東西，所以我認爲這將很高興分享！

根據這一Doxygen gotchas文章我終於發現：你需要添加一個文件與DOX擴展。其內容應包含C風格的註釋塊：

/*! 
    \page My test page 
    contents 
    ... 
    more contents 
*/

確保您的自定義文件放在其中包括在INPUT設置或在當前目錄中，如果輸入爲空目錄，所以這些文件可以發現。

來源

2010-06-16 09:29:21 Veger

我認爲你的代碼示例有一個小錯誤。「page」特殊命令之前的標記必須是「@」或「\」。我試圖按照原樣使用您的示例，但未生成頁面，但是使用該小修補程序可以正常工作。 – wil 2012-03-12 01:57:26

Markdown現在也可用。 [Here's]（http://stackoverflow.com/a/9522667/339872）如何使用它。 – antitoxic 2012-03-13 11:18:07

只需將您的自定義文件列在doxyfile的INPUT宏中。你可以選擇你認爲合適的名字。格式是帶有Doxygen標籤的文本。

來源

2010-06-16 09:33:50 mouviciel

我試過了，但文件被包含爲源文件（添加到文件列表中）。使用dox擴展似乎可以防止這種情況 – Veger 2010-06-16 10:36:37

只是爲了完整：有3種可能的擴展名，它們將doxygen視爲額外的文檔文件：.dox，.txt和.doc。

從文件索引中隱藏了這樣的擴展名的文件。在文件內部，您需要放置一個或多個C/C++樣式的註釋塊。

來源

2011-06-13 21:07:37 doxygen

+14

由於這在google上仍然非常流行：看起來像現在，.md必須添加到該列表中。 – Lukx 2015-02-03 12:58:37

使用doxygen 1.8.13，.txt不起作用。 .md適合我。 – Fabian 2017-05-05 06:45:17

爲了更加完整，從Doxygen版本1.8（我相信）開始，它現在支持與markdown語法非常相似的其他文本文件。您不再需要使用C/C++樣式的註釋塊。相反，只需編寫幾乎正常文本並確保文本文件位於INPUT路徑中，並且doxygen掃描實際上會查找帶.markdown擴展名（或您選擇使用的任何其他擴展名，如.md）的文件。

來源

2012-05-22 17:12:04 DXM

我並不積極（可能將此視爲一個問題），但我沒有看到將\ dot這樣的命令添加到降價文檔中的方法。 – pedz 2014-01-26 01:11:27

@pedz：自從我跟Doxygen打過一段時間後（換了一段時間的工作），所以不記得所有的細節。您不能將任何自定義標籤添加到降價。它必須得到解析器的支持，但我相信「\ dot」是一個有效的標記：http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddot。因此可能a）您的配置文件中沒有正確的版本或b）您沒有指定DOT工具可用。 – DXM 2014-01-26 02:55:53

爲清楚：

在.dox配置文件，該文件的東西加到輸入指令是這樣的：

INPUT = ../src \ 
     ../include \ 
     ../docs/my-extra-file.txt

如果該文件有相應的擴展，說喜歡.H或者.c，那麼Doxygen會在不添加INPUT指令的情況下找到該文件。裏面的文件正常使用Doxygen的標籤，如源，即註釋塊內，如：

/*! \mainpage MyProject - A Brief Description. 
\image html Mylogo.png 
\section my-intro MyProject Introduction 
\htmlinclude about-MyProject.html 
*/

人們可以也只是在上面的例子中使用包括標籤中的一個，像「\ htmlinclude」，任何在代碼中的哪裏。

來源

2014-03-25 06:47:27 Wiley

如何在Doxygen中包含自定義文件

回答

相關問題