向Doxygen提供庫文檔的文檔存根

我的項目中有許多類實現INotifyPropertyChanged。我希望每個PropertyChanged事件都能夠從界面繼承文檔，但由於該界面不是我的項目的一部分，因此它沒有Doxygen頁面。向Doxygen提供庫文檔的文檔存根

我能夠獲得本文檔的接口的部分文檔，出現類頁面，並且繼承圖顯示了所有實現它的類。但我無法宣佈一個事件。是否有我缺少的關鍵字添加事件？

namespace MyNamespace 
{ 
    /** 
    * @class INotifyPropertyChanged 
    * @brief Interface to allow subscribers to know when the object has been updated. See <a href="http://msdn.microsoft.com/en-us/library/system.componentmodel.inotifypropertychanged.aspx">MSDN Doc</a> 
    * @fn void INotifyPropertyChanged::PropertyChanged(sender, e) 
    * @memberof INotifyPropertyChanged 
    * @brief Notification that a property of the object has changed. 
    * @details the name of the property is in the event arguments 
    * Still having trouble documenting the parameters correctly, but this doesn't inherit anyway because it's a function, not an event 
    */ 
}

還是我完全錯過了船，有一些方法來導入Intellisense文檔？

來源

2013-02-28 Denise Skidmore

是否有現有的標記文件.net庫？ – 2013-03-05 14:54:36

嘗試創建INotifyPropertyChanged.cs文件，並在其中放入文檔化的接口聲明，但不要包含到任何編譯項目中，它應該僅由doxygen選取。

據doxygen documentation，它支持標準ECMA-334 XML標籤，通常用來評C＃代碼，所以沒有必要使用@class，@brief標籤等

來源

2013-04-23 19:56:58 Alexander

謝謝！我會嘗試的！我知道XML風格，這是我喜歡的風格，但是你要做客戶付錢給你做的事情，客戶要求@風格的文檔。 – 2013-04-23 21:29:04

靠近。子類Doxygen輸出在事件摘要中將事件列出兩次，一次作爲子版本，一次作爲接口版本。在「事件文檔」部分僅列出子版本。如果我向子版本添加一個'/ ** @copydoc System :: ComponentModel :: INotifyPropertyChanged :: PropertyChanged * /'，它們都會被記錄下來。沒有copydoc，子版本不會被記錄。使INotifyPropertyChanged類或接口具有相同的結果。 – 2013-04-23 22:00:01

向Doxygen提供庫文檔的文檔存根

回答

相關問題