Doxygen在C#生成的文档中使用模板而不是泛型

时间:2015-05-27 04:53:06

标签: c# generics doxygen

我的源代码中有一个泛型类型,我有一些文档。我正在对源代码运行doxygen,同时启用Optmize for Java or C# output,以便我可以为我的项目提供文档。我的一个文件中的XML注释如下所示:

/// <summary>
/// <para>
/// The Engine Timer allows for starting a timer that will execute a callback at a given interval.
/// </para>
/// <para>
/// The timer may fire:
///  - infinitely at the given interval
///  - fire once
///  - fire _n_ number of times.
/// </para>
/// <para>
/// The Engine Timer will stop its self when it is disposed of.
/// </para>
/// <para>
/// The Timer requires you to provide it an instance that will have an operation performed against it.
/// The callback will be given the generic instance at each interval fired.
/// </para>
/// <para>
/// In the following example, the timer is given an instance of an IPlayer. 
/// It starts the timer off with a 30 second delay before firing the callback for the first time.
/// It tells the timer to fire every 60 seconds with 0 as the number of times to fire. When 0 is provided, it will run infinitely.
/// Lastly, it is given a callback, which will save the player every 60 seconds.
/// @code
/// var timer = new EngineTimer<IPlayer>(new DefaultPlayer());
/// timer.StartAsync(30000, 6000, 0, (player, timer) => player.Save());
/// @endcode
/// </para>
/// </summary>
/// <typeparam name="T">The type that will be provided when the timer callback is invoked.</typeparam>
public sealed class EngineTimer<T> : CancellationTokenSource, IDisposable
{
}

然而,生成的文档说这个场景中的TTemplate Parameter,我认为它是C ++ 11的东西(?)。

enter image description here

我是否有办法在向导中重命名,以便Generic Type Parameter表示Engine

我还注意到,当文档包含Engine或其他命名空间名称时,它会向命名空间文档页面添加超链接。在某些情况下,我是否可以使用任何标记告诉Doxygen忽略var a = [{"id":1,"relationship_type_id":"3"}, {"id":2,"relationship_type_id":"2"}, {"id":3,"relationship_type_id":"1"},]; var b = [{"relationship_type_id":1,"contributing":"yes"}, {"relationship_type_id":2,"contributing":"no"}, {"relationship_type_id":3,"contributing":"yes"}]; var arr = []; for(var i=0;i<b.length;i++) for(var j=0;j<a.length;j++){ if(b[i].contributing == "yes" && a[j].relationship_type_id == b[i].relationship_type_id){ arr.push({"id" : a[i].id}); } } console.log(JSON.stringify(arr)); ,例如在上面的XML中,而不是在所有XML中?

我查看了文档,但在这两个问题上都显得空洞。

由于

0 个答案:

没有答案