vnfs/VES5.0/doxygen-1.8.12/html/xmlcmds.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>Doxygen: XML Commands</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="resize.js"></script>
  14 <script type="text/javascript" src="navtreedata.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18 </script>
  19 <link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
  20 </head>
  21 <body>
  22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23 <div id="titlearea">
  24 <table cellspacing="0" cellpadding="0">
  25  <tbody>
  26  <tr style="height: 56px;">
  27   <td id="projectalign" style="padding-left: 0.5em;">
  28    <div id="projectname">Doxygen
  29    </div>
  30   </td>
  31  </tr>
  32  </tbody>
  33 </table>
  34 </div>
  35 <!-- end header part -->
  36 <!-- Generated by Doxygen 1.8.12 -->
  37 </div><!-- top -->
  38 <div id="side-nav" class="ui-resizable side-nav-resizable">
  39   <div id="nav-tree">
  40     <div id="nav-tree-contents">
  41       <div id="nav-sync" class="sync"></div>
  42     </div>
  43   </div>
  44   <div id="splitbar" style="-moz-user-select:none;"
  45        class="ui-resizable-handle">
  46   </div>
  47 </div>
  48 <script type="text/javascript">
  49 $(document).ready(function(){initNavTree('xmlcmds.html','');});
  50 </script>
  51 <div id="doc-content">
  52 <div class="header">
  53   <div class="headertitle">
  54 <div class="title">XML Commands </div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57 <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>
  58 <p>Here is the list of tags supported by doxygen:</p>
  59 <ul>
  60 <li>
  61 <code>&lt;c&gt;</code> Identifies inline text that should be rendered as a piece of code. Similar to using <code>&lt;tt&gt;</code>text<code>&lt;/tt&gt;</code>. </li>
  62 <li>
  63 <code>&lt;code&gt;</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>&lt;code&gt;...&lt;/code&gt;</code> for other languages. </li>
  64 <li>
  65 <code>&lt;description&gt;</code> Part of a <code>&lt;list&gt;</code> command, describes an item. </li>
  66 <li>
  67 <code>&lt;example&gt;</code> Marks a block of text as an example, ignored by doxygen. </li>
  68 <li>
  69 <code>&lt;exception cref="member"&gt;</code> Identifies the exception a method can throw. </li>
  70 <li>
  71 <code>&lt;include&gt;</code> Can be used to import a piece of XML from an external file. Ignored by doxygen at the moment. </li>
  72 <li>
  73 <code>&lt;inheritdoc&gt;</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>
  74 <li>
  75 <code>&lt;item&gt;</code> List item. Can only be used inside a <code>&lt;list&gt;</code> context. </li>
  76 <li>
  77 <code>&lt;list type="type"&gt;</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>&lt;item&gt;</code> tags. A list of type table, is a two column table which can have a header. </li>
  78 <li>
  79 <code>&lt;listheader&gt;</code> Starts the header of a list of type "table". </li>
  80 <li>
  81 <code>&lt;para&gt;</code> Identifies a paragraph of text. </li>
  82 <li>
  83 <code>&lt;param name="paramName"&gt;</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>
  84 <li>
  85 <code>&lt;paramref name="paramName"&gt;</code> Refers to a parameter with name "paramName". Similar to using <a class="el" href="commands.html#cmda">\a</a>. </li>
  86 <li>
  87 <code>&lt;permission&gt;</code> Identifies the security accessibility of a member. Ignored by doxygen. </li>
  88 <li>
  89 <code>&lt;remarks&gt;</code> Identifies the detailed description. </li>
  90 <li>
  91 <code>&lt;returns&gt;</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>
  92 <li>
  93 <code>&lt;see cref="member"&gt;</code> Refers to a member. Similar to <a class="el" href="commands.html#cmdref">\ref</a>. </li>
  94 <li>
  95 <code>&lt;seealso cref="member"&gt;</code> Starts a "See also" section referring to "member". Similar to using <a class="el" href="commands.html#cmdsa">\sa</a> member. </li>
  96 <li>
  97 <code>&lt;summary&gt;</code> Identifies the brief description. Similar to using <a class="el" href="commands.html#cmdbrief">\brief</a>. </li>
  98 <li>
  99 <code>&lt;term&gt;</code> Part of a <code>&lt;list&gt;</code> command. </li>
 100 <li>
 101 <code>&lt;typeparam name="paramName"&gt;</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>
 102 <li>
 103 <code>&lt;typeparamref name="paramName"&gt;</code> Refers to a parameter with name "paramName". Similar to using <a class="el" href="commands.html#cmda">\a</a>. </li>
 104 <li>
 105 <code>&lt;value&gt;</code> Identifies a property. Ignored by doxygen. </li>
 106 </ul>
 107 <p>Here is an example of a typical piece of code using some of the above commands:</p>
 108 <div class="fragment"><div class="line"><span class="comment">/// &lt;summary&gt;</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">/// &lt;/summary&gt;</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">  /// &lt;summary&gt;</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">  /// &lt;/summary&gt;</span></div><div class="line"><span class="comment">  /// &lt;param name=&quot;connectionString&quot;&gt;the connection string to connect to the</span></div><div class="line"><span class="comment">  /// database holding the content to search&lt;/param&gt;</span></div><div class="line"><span class="comment">  /// &lt;param name=&quot;maxRows&quot;&gt;The maximum number of rows to</span></div><div class="line"><span class="comment">  /// return in the result set&lt;/param&gt;</span></div><div class="line"><span class="comment">  /// &lt;param name=&quot;searchString&quot;&gt;The text that we are searching for&lt;/param&gt;</span></div><div class="line"><span class="comment">  /// &lt;returns&gt;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&lt;/returns&gt;</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 --><p>
 109 Go to the <a href="langhowto.html">next</a> section or return to the
 110  <a href="index.html">index</a>.
 111  </p>
 112 </div></div><!-- contents -->
 113 </div><!-- doc-content -->
 114 <!-- start footer part -->
 115 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 116   <ul>
 117     <li class="footer">Generated by
 118     <a href="http://www.doxygen.org/index.html">
 119     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 120   </ul>
 121 </div>
 122 </body>
 123 </html>