函數文檔 - >的Doxygen

Doxygen的重複功能的文檔，當它遇到函數原型在頭文件，例如：函數文檔 - >的Doxygen

代碼：

#include <File main.h> 

void Func1(void); 


///File main.c: 

#include <main.h> 

/*! Main program entry point. */ 
main() 
{ 
    Func1(); 
} 

/*! Test function which does nothing. */ 
void Func1(void) 
{ 
    return; 
}

產生兩個大量的文件對於Func1（）：main.c 文檔中的第一個，以及main.h文檔中的第二個。對於大型項目，這幾乎使重複冗餘功能文檔的文檔大小加倍。這是一個錯誤還是一些配置問題？

來源

2012-02-20 nishant nair

你爲'INPUT ='和'FILE_PATTERNS ='設置了什麼值？ – hmjd 2012-02-20 15:37:35

您應該複製函數原型而不是實現。但也許只是設置HIDE_UNDOC_MEMBERS到YES可以解決您的問題。

來源

2012-02-20 15:36:20 pmr

將doxygen配置爲按名稱空間對自由函數進行分組，而不是按文件進行分組。

來源

2012-02-20 17:57:06

如果您將EXTRACT_ALL設置爲NO並且僅使用（/** @file */）記錄頭文件，那麼doxygen將只顯示頭文件，並且仍然包含在函數定義中找到的文檔。

如果您同時記錄頭文件和源文件或將EXTRACT_ALL設置爲YES，那麼doxygen會將該函數的文檔顯示爲頭文件的一部分，並作爲源文件文檔的一部分。這是功能，不是bug :-)

來源

2012-02-20 19:40:45 doxygen

函數文檔 - >的Doxygen

回答

相關問題