通过Breathe

时间:2015-08-27 15:38:15

标签: c# properties doxygen python-sphinx read-the-docs

我正在使用Doxygen,Breathe和Sphinx创建一些我想要的文档阅读有关简单C#库的文档。最初,我的make.bat脚本给了我很多错误,我意识到这是因为在Doxygen中使用了完全限定的名称;我通过Doxygen HIDE_SCOPE_NAMES选项解决了这个问题。

不幸的是,我的属性仍未正确记录。首先,与为我的方法生成的文档不同,该属性的名称仍然是完全限定的(即NAMESPACE::CLASS::PROPERTY)。此外,生成的“阅读文档”文档不包含属性的数据类型,并且未正确获取注释标记。我的C#代码如下所示:

/// <summary>
/// Gets or sets the property.
/// </summary>
/// <value>
/// The property.
/// </value>
public int Property { get; set; }

但生成的文档如下所示:

  

属性NAMESPACE :: CLASS :: Property

     

获取或设置属性。

     

财产。

我想看到这样的事情:

  

property int Property

     

摘要:获取或设置属性。

     

价值:财产。

有谁知道如何实现这种效果?

make.bat脚本继续为我提供这些属性的错误。

0 个答案:

没有答案