/usr/share/doc/doxygen/html/xmlcmds.html is in doxygen-doc 1.8.6-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Doxygen: XML Commands</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Doxygen
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xmlcmds.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">XML Commands </div> </div>
</div><!--header-->
<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 <a class="el" href="commands.html#cmdcode">\code</a> ... <a class="el" href="commands.html#cmdendcode">\endcode</a> 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><inheritdoc></code> Can be used to insert the documentation of a member of a base class into the documentation of a member of a derived class that reimplements it. </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"><div class="line"><span class="comment">/// <summary></span></div>
<div class="line"><span class="comment"></span><span class="comment">/// A search engine.</span></div>
<div class="line"><span class="comment"></span><span class="comment">/// </summary></span></div>
<div class="line"><span class="comment"></span><span class="keyword">class </span>Engine</div>
<div class="line">{<span class="comment"></span></div>
<div class="line"><span class="comment"> /// <summary></span></div>
<div class="line"><span class="comment"> /// The Search method takes a series of parameters to specify the search criterion</span></div>
<div class="line"><span class="comment"> /// and returns a dataset containing the result set.</span></div>
<div class="line"><span class="comment"> /// </summary></span></div>
<div class="line"><span class="comment"> /// <param name="connectionString">the connection string to connect to the</span></div>
<div class="line"><span class="comment"> /// database holding the content to search</param></span></div>
<div class="line"><span class="comment"> /// <param name="maxRows">The maximum number of rows to</span></div>
<div class="line"><span class="comment"> /// return in the result set</param></span></div>
<div class="line"><span class="comment"> /// <param name="searchString">The text that we are searching for</param></span></div>
<div class="line"><span class="comment"> /// <returns>A DataSet instance containing the matching rows. It contains a maximum</span></div>
<div class="line"><span class="comment"> /// number of rows specified by the maxRows parameter</returns></span></div>
<div class="line"><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)</div>
<div class="line"> {</div>
<div class="line"> DataSet ds = <span class="keyword">new</span> DataSet();</div>
<div class="line"> <span class="keywordflow">return</span> ds;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
Go to the <a href="langhowto.html">next</a> section or return to the
<a href="index.html">index</a>.
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Mon Jan 27 2014 11:24:40 for Doxygen by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
|