2011-02-23 39 views
5

我們使用doxygen來記錄我們的類。我想明確地說明一個類已經生成了構造函數和/或析構函數,以表明我已經考慮過它並決定例如使用生成的拷貝構造函數進行復制是安全的。但是,構造函數/析構函數沒有聲明,因此doxygen不知道文檔屬於哪個函數。有沒有辦法使doxygen包含函數註釋,即使函數從未被聲明過?如何在doxygen中生成構造函數文件

//! The Foo class documentation 
class Foo { 
    //! @fn Foo(const Foo&) 
    //! Generated copy constructor OK to use 

    //! method documentation 
    void method(); 
} 

此外,我不想寫的生成的文件的簽名在所有。

我想我的另一種選擇是隻在類頭中描述它。還有其他方法嗎?

+3

你真的看到任何理由來文件複製構造?我的意思是它很明顯是什麼,如果你允許使用生成的構造函數,那麼你作爲作者顯然可以。 – 2011-02-23 13:22:31

+4

爲什麼像Doxygen這樣的工具不能生成*有用的*文檔的很好的例子。告訴用戶該課程是可複製的。 – jalf 2011-02-23 13:30:56

回答

相關問題