【发布时间】:2015-08-11 21:58:47
【问题描述】:
对于下面的注释块,doxygen 不会在输出的 xml 中添加备注标签。这是在 cmets 块中正确使用 xml 备注标记吗? 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<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.</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>
【问题讨论】:
标签: doxygen