为库类提供Doxygen文档存根

时间:2013-02-28 21:59:37

标签: c# doxygen inotifypropertychanged

我的项目中有许多实现INotifyPropertyChanged的类。我希望每个中的所有PropertyChanged事件都能够从界面继承文档,但由于界面不是我的项目的一部分,因此它没有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文档?

1 个答案:

答案 0 :(得分:1)

尝试创建INotifyPropertyChanged.cs文件,将文档化的接口声明放在那里,但不要包含在任何编译项目中,它应该只由doxygen选择。

根据doxygen documentation,它支持标准的ECMA-334 XML标记,这些标记通常用于注释C#代码,因此不需要使用@ class,@ brief标记等。