summaryrefslogtreecommitdiffstats
tag namev3.5.1 (22da5dc5346a084bebe512eb43365460d53188ac)
tag date2016-03-24 16:42:14 (GMT)
tagged byBrad King <brad.king@kitware.com>
tagged objectcommit 64130a7e79...
downloadCMake-3.5.1.zip
CMake-3.5.1.tar.gz
CMake-3.5.1.tar.bz2
CMake 3.5.1
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1 iQIcBAABAgAGBQJW9BjmAAoJEC0s7xA0khaE7qgP/26J6KhQcLaxc010HuFZOPwz EDJTGSBRdfisUdXDBKWdHMJ1LmFWAICbCzMvHsdGwICeRS9LeRlNyQ8RN2u/Wi9h NFC2DgNSfT3/Sk1ZoKk7/hSSqgnnYZp86J4f+2Xo1ArgBVJI52EpsIw0uyoviZyh 0bOrJ3Jpe9I9pQNyXHliO0GSQwvPCB1U1y85z9M/60IuMLFuozE0j9XLTDzVUEud Ow4wz/va4/N51b2rkQM42+m5nRQ1Hy5xhVCo10n+snwj/ZR51laxBbLqWZAzqs3c y50+p4cDRSzAXRGcBdJhzm3ndDs8hFSCjbB2uUva4vcDVgqrichKFzOkMZNtbSy+ pRfuBqdV4k+B2qHIFTMU9h4Q5pSHveHaF/RyBMJBbbApiCxzsguA67SWcM6o792X HS1BQEkxj9OFECSEnOF03+A3rVU5tO0qsKgnw0iXlBiIIZ0xOBVkGAx0/9Ew1nWV pNY8VLGBIDOoX+w2/0h4lHiLu0TIRoXRVxb9ngwIv8oWjUc4SAAbMiWbVJGfAnws xkTty+/8vRIWsedJP+deIl2kXGvUus8W7qufS6VIyK22vb1L16uqD4IzPEU++p7V m3VdjAN4y+8ZwnQbi8lKQkSOnDy/21vIA2ZZ0FuRwjYGtUBUFFFXev7JyW3RPCy5 qx3fzuFq78LFKEvy+I3j =icPY -----END PGP SIGNATURE-----
generated by cgit v0.12 at 2026-01-10 16:24:46 (GMT)
href='#n32'>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 
/******************************************************************************
 *
 * 
 *
 * Copyright (C) 1997-2015 by Dimitri van Heesch.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */
/*! \page xmlcmds XML Commands

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.

Here is the list of tags supported by doxygen:

<ul>
<li><tt>\<c\></tt>     Identifies inline text that should be rendered as a 
                       piece of code. Similar to using <tt>\<tt\></tt>text<tt>\</tt\></tt>.
<li><tt>\<code\></tt>  Set one or more lines of source code or program output.
                       Note that this command behaves like \ref cmdcode "\\code" ... \ref cmdendcode "\\endcode"
                       for C# code, but it behaves like the HTML equivalent
                       <tt>\<code\>...\</code\></tt> for other languages.
<li><tt>\<description\></tt> Part of a <tt>\<list\></tt> command, describes an item.
<li><tt>\<example\></tt> Marks a block of text as an example, ignored by doxygen.
<li><tt>\<exception cref="member"\></tt> Identifies the exception a 
                         method can throw.
<li><tt>\<include\></tt> Can be used to import a piece of XML from an external
                         file. Ignored by doxygen at the moment.
<li><tt>\<inheritdoc\></tt> 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><tt>\<item\></tt> List item. Can only be used inside a <tt>\<list\></tt> context.
<li><tt>\<list type="type"\></tt> Starts a list, supported types are <tt>bullet</tt>
                         or <tt>number</tt> and <tt>table</tt>. 
                         A list consists of a number of <tt>\<item\></tt> tags.
                         A list of type table, is a two column table which can have
                         a header.
<li><tt>\<listheader\></tt>   Starts the header of a list of type "table".
<li><tt>\<para\></tt>    Identifies a paragraph of text.
<li><tt>\<param name="paramName"\></tt> Marks a piece of text as the documentation
                         for parameter "paramName". Similar to 
                         using \ref cmdparam "\\param".
<li><tt>\<paramref name="paramName"\></tt> Refers to a parameter with name
                         "paramName". Similar to using \ref cmda "\\a".
<li><tt>\<permission\></tt> Identifies the security accessibility of a member.
                         Ignored by doxygen.
<li><tt>\<remarks\></tt> Identifies the detailed description. 
<li><tt>\<returns\></tt> Marks a piece of text as the return value of a
                         function or method. Similar to using \ref cmdreturn "\\return".
<li><tt>\<see cref="member"\></tt> Refers to a member. Similar to \ref cmdref "\\ref".
<li><tt>\<seealso cref="member"\></tt> Starts a "See also" section referring
                         to "member". Similar to using \ref cmdsa "\\sa" member.
<li><tt>\<summary\></tt> Identifies the brief description.
                         Similar to using \ref cmdbrief "\\brief".
<li><tt>\<term\></tt>    Part of a <tt>\<list\></tt> command.
<li><tt>\<typeparam name="paramName"\></tt> Marks a piece of text as the documentation
                         for type parameter "paramName". Similar to 
                         using \ref cmdparam "\\param".
<li><tt>\<typeparamref name="paramName"\></tt> Refers to a parameter with name
                         "paramName". Similar to using \ref cmda "\\a".
<li><tt>\<value\></tt>   Identifies a property. Ignored by doxygen.
<li><tt>\<![CDATA[...]]\></tt> The text inside this tag (on the ...) is  handled as normal
                         doxygen comment except for the XML special characters `<`, `>` and
                         `&` that are used as if they were escaped.
</ul>

Here is an example of a typical piece of code using some of the above commands:

\code
/// <summary>
/// A search engine.
/// </summary>
class Engine
{
  /// <summary>
  /// The Search method takes a series of parameters to specify the search criterion
  /// and returns a dataset containing the result set.
  /// </summary>
  /// <param name="connectionString">the connection string to connect to the
  /// database holding the content to search</param>
  /// <param name="maxRows">The maximum number of rows to
  /// return in the result set</param>
  /// <param name="searchString">The text that we are searching for</param>
  /// <returns>A DataSet instance containing the matching rows. It contains a maximum
  /// number of rows specified by the maxRows parameter</returns>
  public DataSet Search(string connectionString, int maxRows, int searchString)
  {
    DataSet ds = new DataSet();
    return ds;
  }
}
\endcode


\htmlonly
Go to the <a href="emojisup.html">next</a> section or return to the
 <a href="index.html">index</a>.
\endhtmlonly

*/
generated by cgit v0.12 at 2026-01-10 16:24:46 (GMT)