2010-09-07 49 views
4

我在Objective-C中編寫項目,我已經開始使用Doxygen自動生成文檔。該項目的重要部分包含基本的C函數。不幸的是,Doxygen沒有記錄C函數,只有Objective-C類和它們的方法。我有幾個頭文件中定義的功能,如下所示:Objective-C項目中的Doxygen文檔C函數

BOOL myFunc(void); 

然後我在.m中實現了這些功能。

Doxygen沒有在Objective-C中檢測到直接的C函數,還是有一個選項需要打開?我的功能是否對Doxygen的定義不正確?

回答

2

Doxygen肯定會記錄直接的C函數。

更多的測試後

使用Doxywizard併爲您在專家模式的價值 - 它提供了一些很好的幫助,當你鼠標的事情。特別是,你應該已經更改了默認設置,以便EXTRACT_ALL是 檢查

我覺得這需要進行設置,相反爲默認值,可能是一個錯誤。

如果不顧一切,請在問題中發佈設置。我只是從頭開始創建了一個樣本,並驗證了當我使用EXTRACT_ALL時使用Doxygen顯示了您的函數,但如果關閉它,則沒有File Members部分。

您應該在VTK文檔中看到Files - File Members下的函數爲seen here

對不起,我以前沒有拿起它,但我總是有EXTRACT_ALL,因爲我在遺傳代碼庫上工作,大多數功能缺乏特殊的註釋。

先前的想法嘗試在文件頂部添加@file註釋以查看是否正在處理該文件。

/// @file fred.h This file defines functions used in fred.m 

我敢打賭,您的文件擴展名或您的目錄不包含在您正在運行的doxygen安裝文件中。

+0

不能處理它的definitley。這些文件在其中列出。我試過你的@file文件沒有任何幫助。在Objective C下運行時,它堅持只是方法並避免c函數? – 2010-09-10 22:35:33

+0

好吧,現在工作得更好,現在列出所有這些都很棒,但它仍然沒有將它們與評論一起記錄下來。 – 2010-09-11 15:29:53

+0

NVM我修好了,非常感謝你! (我會盡快給你賞金:) – 2010-09-11 15:31:09