Doxygen无法在注释中识别备注xml标记

时间:2015-08-11 21:58:47

标签: doxygen

对于以下注释块,doxygen不会在输出的xml中添加备注标记。这是在注释块中正确使用xml remarks标记吗?似乎在doxygen中支持它:http://www.doxygen.nl/manual/xmlcmds.html

评论栏:

/// <summary>
/// Returns an AchievementsResult object containing the first page of achievements
/// for a player of the specified title.
/// </summary>
/// <param name="titleId">The title ID.</param>
/// <param name="type">The achievement type to retrieve.</param>
/// <param name="orderby">Controls how the list of achievements is ordered.</param>
/// <param name="skipItems">The number of achievements to skip.</param>
/// <param name="maxItems">The maximum number of achievements the result can contain.  Pass 0 to attempt
/// to retrieve all items.</param>
/// <returns>An AchievementsResult object that contains a list of Achievement objects.</returns>
/// <remarks>
/// Returns an IAsyncOperation<TResult> object that represents the state of the asynchronous operation.
/// Completion of the asynchronous operation is signaled by using a handler that is passed to the
/// IAsyncOperation<TResult>.Completed property. When the asynchronous operation is complete, the result of the
/// operation can be retrieved by using the IAsyncOperation<TResult>.GetResults method.
///
/// See AchievementsResult::GetNextAsync to page in the next set of results.
///
/// This method calls V2 GET /users/xuid({xuid})/achievements.
/// </remarks>

Doxygen XML:

...
</simplesect>
</para>
<para>Returns an IAsyncOperation&lt;TResult&gt; object that represents the state of the asynchronous operation. Completion of the asynchronous operation is signaled by using a handler that is passed to the IAsyncOperation&lt;TResult&gt;.Completed property. When the asynchronous operation is complete, the result of the operation can be retrieved by using the IAsyncOperation&lt;TResult&gt;.GetResults method.</para>
<para>See <ref refid="class_d3337fa7a" kindref="member">AchievementsResult::GetNextAsync</ref> to page in the next set of results.</para>
<para>This method calls V2 GET /users/xuid({xuid})/achievements.</para>
</detaileddescription>

1 个答案:

答案 0 :(得分:1)

Doxygen的XML输出遵循与C#XML输入不同的模式(它甚至没有定义适当的模式)。因此,输入中的<remarks> ... </remarks>最终会在输出中的<detaileddescription> ... </detaileddescription>容器中显示为一组段落。

相关问题