2014-09-04 44 views
1

我敢肯定這是愚蠢的事我已經做了,但我看不出它是什麼:的Doxygen似乎並沒有意識到評論(Doxywizard)

所以我有C++項目具有的main.cpp文件和一些類。它不是用doxygen寫的(錯誤#1),但我想糾正我的錯誤並生成一些文檔。因此,我安裝了doxygen並運行了doxygen GUI,輸入了項目名稱/摘要並指定了源和目標位置。

也獲得以上功能的一些輸出我加在doxygen的規範要求風格的註釋:

//! My actual function doesn't really look like this 
/*! 
* Some sample detail which isn't exactly the same as the main 
* function but the structure is the same 
*/ 
void sampleFunction() 
{ 
    doSomethingUninteresting(); 
} 

然而,當我在doxywizard沒有額外的評論是由打運行。

如果我將提取模式設置爲記錄實體,則main.cpp甚至不會顯示。如果我將它設置爲所有實體main.cpp出現在文件下並且函數在那裏,但是文件中沒有任何細節。

作爲一個嘗試改造我的項目的完全新手,毫無疑問,我已經省略了一些重要的事情,但是我讀過的所有文檔/教程都沒有提出除我所說的內容之外的任何其他內容。我轉向知識淵博的SO社會提供援助

UPDATE:

在迴應阿恩·默茨這裏的註釋是一些細節:

  • Doxywizard在Program Files文件/ doxygen的/ bin中和配置文件是在哪裏版本doxywizard默認創建它

  • 我的源代碼在用戶/桌面/

  • 輸出文件夾是用戶/桌面/文檔

+0

你可以提供你的doxygen配置,只要它影響從源代碼文件中提取文檔?重現問題的最小但完整的文件也會派上用場,包括文件的路徑,運行doxywizard的位置,doxygen配置的位置以及配置文件中路徑的配置。 – 2014-09-04 10:19:59

+0

我已經更新了所需信息的問題:) – DomAyre 2014-09-04 11:05:00

+1

另外,請提及您使用符號'@'寫的某人的姓名 - 以便通知此人。我不會懷疑艾美梅茲是否甚至不知道你回答了他。例外情況只是您撰寫評論的帖子的作者。即我沒有提到你,但你會收到通知。 – 2014-09-04 12:06:55

回答

0

To document a global functions you have also to include a file name.例如

/*! 
* \file MyFileName.cpp 
* \brief a brief description of a file 
*/ 

//! My actual function doesn't really look like this 
/*! 
* Some sample detail which isn't exactly the same as the main 
* function but the structure is the same 
*/ 
void sampleFunction() 
{ 
    doSomethingUninteresting(); 
} 

注意,那之後\file關鍵字的名稱應該是完全一樣的文件名。

1

我被愚蠢的,因爲我懷疑,爲了安全起見我就做我的項目的副本,所以我編輯的版本不是由版本的doxygen被解釋

我道歉,任何人誰浪費了自己的試圖幫助這個,但我非常感謝你這樣做的嘗試:)

+0

我有和你一樣的問題。當我讀到你的答案時,我笑了(「可能是我」)。那麼,不是這次。我確定。現在,1小時後,我想起了這個,最後三重檢查了我正在編輯的文件的路徑以及給予doxygen的路徑。我的天啊。不能相信它,我真的編輯了錯誤的文件(在項目副本中) - .-所以每個人都閱讀這個答案:仔細檢查,如果沒有幫助,看看其他地方,但這很可能是問題:/ – mozzbozz 2015-01-19 16:20:05