DoxyPress  2.0.0
XML Tags

DoxyPress supports most of the XML commands which are typically used in C# code comments. The following is a list of XML tags which can be used in your documentation.

HTML TagsDescription
<c> Identifies inline text which should be rendered as a piece of code. Similar to using <tt>text</tt>
<code> Marks lines of source code or program output as a code block. This tag behaves like \code ... \endcode for C# or <code>...</code> for other languages
<description> Part of a <list> command, describes an item
<example> Marks a block of text as an example, ignored by DoxyPress
<exception cref="member"> Identifies the exception a method can throw
<include> Used to import a piece of XML from an external file, ignored by DoxyPress at the moment
<inheritdoc> Used to inherit the parent class documentation into the documentation for a member of a child class
<item> List item used inside a <list> tag
<list type="type"> Starts a list. Types can be bullet, number, or table. A list of type table is a two column table which can have a header.
<listheader> Starts the header of a list of type table
<para> Identifies a paragraph of text
<param name="pName"> Used to mark parameter pName. Similar to using \param
<paramref name="pName"> Refers to a parameter with name pName. Similar to using \a
<permission> Identifies the security accessibility of a member, ignored by DoxyPress
<remarks> Identifies the detailed description
<returns> Marks a piece of text as the return value of a function or method. Similar to using \return
<see cref="member"> Refers to a member. Similar to \ref
<seealso cref="member"> Starts a "See also" section referring to "member". Similar to using \sa member
<summary> Identifies the brief description. Similar to using \brief
<term> Part of a <list> command
<typeparam name="pName"> Marks a piece of text as the documentation for type parameter pName. Similar to using \param
<typeparamref name="pName"> Refers to a parameter with name pName. Similar to using \a
<value> Identifies a property, ignored by DoxyPress


The following is an example of a typical piece of code using some of the above commands.

/// <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;
}
}