diff -r 000000000000 -r 42188c7ea2d9 Orb/Doxygen/doc/xmlcmds.doc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Orb/Doxygen/doc/xmlcmds.doc Thu Jan 21 17:29:01 2010 +0000 @@ -0,0 +1,100 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2008 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 +ECMA-334 +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: + +

\ Identifies inline text that should be rendered as a + piece of code. Similar to using \text\. +
\ Set one or more lines of source code or program output. + Note that this command behaves like \\code ... \\endcode + for C# code, but it behaves like the HTML equivalent + \...\ for other languages. +
\ Part of a \ command, describes an item. +
\ Marks a block of text as an example, ignored by doxygen. +
\ Identifies the exception a + method can throw. +
\ Can be used to import a piece of XML from an external + file. Ignored by doxygen at the moment. +
\ List item. Can only be used inside a \ context. +
\ Starts a list, supported types are bullet + or number and table. + A list consists of a number of \ tags. + A list of type table, is a two column table which can have + a header. +
\ Starts the header of a list of type "table". +
\ Identifies a paragraph of text. +
\ Marks a piece of text as the documentation + for parameter "paramName". Similar to + using \ref cmdparam "\\param". +
\ Refers to a parameter with name + "paramName". Similar to using \ref cmda "\\a". +
\ Identifies the security accessibility of a member. + Ignored by doxygen. +
\ Identifies the detailed description. +
\ Marks a piece of text as the return value of a + function or method. Similar to using \ref cmdreturn "\\return". +
\ Refers to a member. Similar to \ref cmdref "\\ref". +
\ Starts a "See also" section referring + to "member". Similar to using \ref cmdsa "\\sa" member. +
\ Identifies the brief description. + Similar to using \ref cmdbrief "\\brief". +
\ Part of a \ command. +
\ Marks a piece of text as the documentation + for type parameter "paramName". Similar to + using \ref cmdparam "\\param". +
\ Refers to a parameter with name + "paramName". Similar to using \ref cmda "\\a". +
\ Identifies a property. Ignored by doxygen. +

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

+/// A search engine. +///

+class Engine +{ + ///

+ /// The Search method takes a series of parameters to specify the search criterion + /// and returns a dataset containing the result set. + ///

+ /// the connection string to connect to the + /// database holding the content to search + /// The maximum number of rows to + /// return in the result set + /// The text that we are searching for + /// A DataSet instance containing the matching rows. It contains a maximum + /// number of rows specified by the maxRows parameter + public DataSet Search(string connectionString, int maxRows, int searchString) + { + DataSet ds = new DataSet(); + return ds; + } +} +\endcode + +*/ +