<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Doxygen manual: XML Commands</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Doxygen manual</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">XML Commands </div> </div>
</div>
<div class="contents">
<div class="textblock"><p>Doxygen supports most of the XML commands that are typically used in C# code comments. The XML tags are defined in Appendix E of the <a href="http://www.ecma-international.org/publications/standards/Ecma-334.htm">ECMA-334</a> standard, which defines the C# language. Unfortunately, the specification is not very precise and a number of the examples given are of poor quality.</p>
<p>Here is the list of tags supported by doxygen:</p>
<ul>
<li>
<code><c></code> Identifies inline text that should be rendered as a piece of code. Similar to using <code><tt></code>text<code></tt></code>. </li>
<li>
<code><code></code> Set one or more lines of source code or program output. Note that this command behaves like <code>\code ... \endcode</code> for C# code, but it behaves like the HTML equivalent <code><code>...</code></code> for other languages. </li>
<li>
<code><description></code> Part of a <code><list></code> command, describes an item. </li>
<li>
<code><example></code> Marks a block of text as an example, ignored by doxygen. </li>
<li>
<code><exception cref="member"></code> Identifies the exception a method can throw. </li>
<li>
<code><include></code> Can be used to import a piece of XML from an external file. Ignored by doxygen at the moment. </li>
<li>
<code><item></code> List item. Can only be used inside a <code><list></code> context. </li>
<li>
<code><list type="type"></code> Starts a list, supported types are <code>bullet</code> or <code>number</code> and <code>table</code>. A list consists of a number of <code><item></code> tags. A list of type table, is a two column table which can have a header. </li>
<li>
<code><listheader></code> Starts the header of a list of type "table". </li>
<li>
<code><para></code> Identifies a paragraph of text. </li>
<li>
<code><param name="paramName"></code> Marks a piece of text as the documentation for parameter "paramName". Similar to using <a class="el" href="commands.html#cmdparam">\param</a>. </li>
<li>
<code><paramref name="paramName"></code> Refers to a parameter with name "paramName". Similar to using <a class="el" href="commands.html#cmda">\a</a>. </li>
<li>
<code><permission></code> Identifies the security accessibility of a member. Ignored by doxygen. </li>
<li>
<code><remarks></code> Identifies the detailed description. </li>
<li>
<code><returns></code> Marks a piece of text as the return value of a function or method. Similar to using <a class="el" href="commands.html#cmdreturn">\return</a>. </li>
<li>
<code><see cref="member"></code> Refers to a member. Similar to <a class="el" href="commands.html#cmdref">\ref</a>. </li>
<li>
<code><seealso cref="member"></code> Starts a "See also" section referring to "member". Similar to using <a class="el" href="commands.html#cmdsa">\sa</a> member. </li>
<li>
<code><summary></code> Identifies the brief description. Similar to using <a class="el" href="commands.html#cmdbrief">\brief</a>. </li>
<li>
<code><term></code> Part of a <code><list></code> command. </li>
<li>
<code><typeparam name="paramName"></code> Marks a piece of text as the documentation for type parameter "paramName". Similar to using <a class="el" href="commands.html#cmdparam">\param</a>. </li>
<li>
<code><typeparamref name="paramName"></code> Refers to a parameter with name "paramName". Similar to using <a class="el" href="commands.html#cmda">\a</a>. </li>
<li>
<code><value></code> Identifies a property. Ignored by doxygen. </li>
</ul>
<p>Here is an example of a typical piece of code using some of the above commands:</p>
<div class="fragment"><pre class="fragment"><span class="comment">/// <summary></span>
<span class="comment"></span><span class="comment">/// A search engine.</span>
<span class="comment"></span><span class="comment">/// </summary></span>
<span class="comment"></span><span class="keyword">class </span>Engine
{<span class="comment"></span>
<span class="comment"> /// <summary></span>
<span class="comment"> /// The Search method takes a series of parameters to specify the search criterion</span>
<span class="comment"> /// and returns a dataset containing the result set.</span>
<span class="comment"> /// </summary></span>
<span class="comment"> /// <param name="connectionString">the connection string to connect to the</span>
<span class="comment"> /// database holding the content to search</param></span>
<span class="comment"> /// <param name="maxRows">The maximum number of rows to</span>
<span class="comment"> /// return in the result set</param></span>
<span class="comment"> /// <param name="searchString">The text that we are searching for</param></span>
<span class="comment"> /// <returns>A DataSet instance containing the matching rows. It contains a maximum</span>
<span class="comment"> /// number of rows specified by the maxRows parameter</returns></span>
<span class="comment"></span> <span class="keyword">public</span> DataSet Search(<span class="keywordtype">string</span> connectionString, <span class="keywordtype">int</span> maxRows, <span class="keywordtype">int</span> searchString)
{
DataSet ds = <span class="keyword">new</span> DataSet();
<span class="keywordflow">return</span> ds;
}
}
</pre></div> </div></div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jun 27 2011 for Doxygen manual by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
