在doxygen中使用\ snippet记录代码片段

时间:2015-03-06 03:40:07

标签: c# .net doxygen

我正在尝试记录使用doxygen创建的API的代码段。按照http://www.doxygen.nl/manual/commands.html#cmdsnippet

上的示例

我有以下示例代码段,我只想在文档页面上的标记[Marker]之间使用代码。此代码驻留在GetValues.cs中。

class example_GetValues : globalParams
{
//!     [Marker]    
public bool GetValues()
    {            
        bool retVal = false;
        try
        {
            Dvr.GetValues();
            retVal = true;
        }
        catch (Exception excp)
        {
            TraceLog.WriteLine("Error" + excp.ToString());
        }
        return retVal;
    }
//!     [Marker]
}

我使用以下内容从另一个文件apiList.cs调用上述内容:

/// <summary>
/// Info about the API    
/// </summary>
/// \snippet GetValues.cs Marker

我可以看到关于API&#39;的所有信息。在我的文档中,但只有一个空框来代替片段。

有关使用文档生成代码段的问题,或者在C#中以不同方式使用\snippet命令的任何线索?

0 个答案:

没有答案