【问题标题】:Doxygen not recognizing remarks xml tag in commentsDoxygen 无法识别评论中的评论 xml 标签
【发布时间】: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&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>

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    Doxygen 的 XML 输出遵循与 C# XML 输入不同的模式(甚至没有定义适当的模式)。因此,输入中的&lt;remarks&gt;...&lt;/remarks&gt; 最终成为输出中&lt;detaileddescription&gt;...&lt;/detaileddescription&gt; 容器中的一组段落。

    【讨论】:

    猜你喜欢
    • 2014-10-29
    • 1970-01-01
    • 1970-01-01
    • 2012-06-26
    • 2013-07-10
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多