[JEDI.NET-commits] web jedidoc.tags.htm,NONE,1.1 frameleft.htm,1.1,1.2
Status: Pre-Alpha
Brought to you by:
jedi_mbe
Menu
▾
▴
[JEDI.NET-commits] web jedidoc.tags.htm,NONE,1.1 frameleft.htm,1.1,1.2
|
From: Marcel B. <jed...@us...> - 2005-07-09 09:34:28
|
Update of /cvsroot/jedidotnet/web In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26909/web Modified Files: frameleft.htm Added Files: jedidoc.tags.htm Log Message: Added JediDoc tool tag reference --- NEW FILE: jedidoc.tags.htm --- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> <link rel="STYLESHEET" href="styles/default.css" type="text/css"> <title>JediDoc tool tag processing</title> </head> <body> <h1>JediDoc tool tag processing</h1> <p> </p> <p> The JediDoc tool is used to process the assemblies and create or update the unit-based XML files. In addition it will merge those unit-based XML files to create the assembly-based XML files, which can be used by tools like <a href="http://ndoc.sourceforge.net">nDoc</a> or for help insight. </p> <p> During the merging of the unit-based XML files, the JediDoc tool will process certain tags and perform some task (usually replacing the tag with a fixed text). Below is a list of all recognised and processed tags. </p> <p> </p> <h2><b>case</b></h2> <p> The first occurance of the <b>case</b> tag within a group will result in its contents being placed inside <b><para></b> tags. Any following occurrence, immediately following the previous one, will also be placed inside <b><para></b> tags, but the fragment <code><para>-or-</para></code> will be added before the new paragraph. </p> <p> There are two additional tags that perform the same expansion: the <b><condition></b> tag and the <b><option></b> tag. Within a group, the three tags can be freely mixed. </p> <p>Input:</p> <pre><returns> <case>An empty string if nothing was found</case> <case>A string representing the found item.</case> </returns></pre> <p>Output:</p> <pre><returns> <para>An empty string if nothing was found</para> <para>-or-</para> <para>A string representing the found item.</para> </returns></pre> <p> </p> <h2><b>condition</b></h2> <p> The first occurance of the <b>condition</b> tag within a group will result in its contents being placed inside <b><para></b> tags. Any following occurrence, immediately following the previous one, will also be placed inside <b><para></b> tags, but the fragment <code><para>-or-</para></code> will be added before the new paragraph. </p> <p> There are two additional tags that perform the same expansion: the <b><case></b> tag and the <b><option></b> tag. Within a group, the three tags can be freely mixed. </p> <p>Input:</p> <pre><exception cref="T:System.ArgumentRangeException"> <condition>The value was negative</condition> <condition>The value exceeded the number of elements.</condition> </exception> </pre> <p>Output:</p> <pre><exception cref="T:System.ArgumentRangeException"> <para>The value was negative</para> <para>-or-</para> <para>The value exceeded the number of elements.</para> </exception></pre> <p> </p> <h2><b>ctor</b></h2> <p> The <b>ctor</b> tag expands to the common constructor summary text <code>Initializes a new instance of the <see cref="T:<i>qualified class name</i>" /> class.</code> where <i>qualified class name</i> is the namespace-qualified class name of the current member. </p> <p> If the <b>ctor</b> tag has contents, the contents is added before the period, prefixed by a comma and a space. </p> <p> Input: </p> <pre><member name="M:Jedi.System.MyClass.#ctor"> <overloads> <ctor /> </overloads> <summary> <ctor>setting it up for recursive searching</ctor> </summary> </member></pre> <p> Output: </p> <pre><member name="M:Jedi.System.MyClass.#ctor"> <overloads> Initializes a new instance of the <see cref="T:Jedi.System.MyClass" /> class. </overloads> <summary> Initializes a new instance of the <see cref="T:Jedi.System.MyClass" /> class, setting it up for recursive searching. </summary> </member></pre> <p> </p> <h2><b>eventref</b></h2> <p> The <b>eventref</b> tag creates a reference to an event. It accepts various attributes that customize the behavior and provide information about what event to create a link to. The <b>eventref</b> tag is a specialized version of the <b>ref</b> base tag. Below a list of attributes. Attributes colored red are required. </p> <p> <ul> <li> Use the <b><i><font color="red">name</font></i></b> attribute (or the <b><i>member</i></b> attribute) to specify the event to reference. This should be the simple event name, without the declaring class name. </li> <li> Use the <b><i>type</i></b> attribute to specify the type in which the event to reference is declared. This should be the namespace-qualified class name. If this attribute is omitted, the type of the current member is assumed. </li> <li> Use the <b><i>reftype</i></b> attribute to specify whether the type should be referenced separately. This should be either <code>1</code>, <code>true</code> or <code>yes</code>; any other value is interpreted as no. If the <b><i>type</i></b> attribute was omitted or equals the current type, this attribute will be ignored. </li> </ul> </p> <p>Input:</p> <pre><member name="M:System.TestClass.OnMyEvent"> <summary> Raises the <eventref name="MyEvent" /> event. </summary> </member></pre> <p>Output:</p> <pre><member name="M:System.TestClass.OnMyEvent"> <summary> Raises the <see cref="E:System.TestClass.MyEvent" /> event. </summary> </member></pre> <p> </p> <h2><b>fieldref</b></h2> <p> The <b>fieldref</b> tag creates a reference to a field. It accepts various attributes that customize the behavior and provide information about what field to create a link to. The <b>fieldref</b> tag is a specialized version of the <b>ref</b> base tag. Below a list of attributes. Attributes colored red are required. </p> <p> <ul> <li> Use the <b><i><font color="red">name</font></i></b> attribute (or the <b><i>member</i></b> attribute) to specify the field to reference. This should be the simple field name, without the declaring class name. </li> <li> Use the <b><i>type</i></b> attribute to specify the type in which the field to reference is declared. This should be the namespace-qualified class name. If this attribute is omitted, the type of the current member is assumed. </li> <li> Use the <b><i>reftype</i></b> attribute to specify whether the type should be referenced separately. This should be either <code>1</code>, <code>true</code> or <code>yes</code>; any other value is interpreted as no. If the <b><i>type</i></b> attribute was omitted or equals the current type, this attribute will be ignored. </li> </ul> </p> <p>Input:</p> <pre><member name="M:System.TestClass.MyMethod"> <summary> Increases the <fieldref name="Version" /> field. </summary> </member></pre> <p>Output:</p> <pre><member name="M:System.TestClass.MyMethod"> <summary> Increases the <see cref="F:System.TestClass.Version" /> field. </summary> </member></pre> <p> </p> <h2><b>include</b></h2> <p> The <b>include</b> tag, though part of the Microsoft specification, is processed by the tool. This is because in normal situations, the compiler will have processed the element before it gets written to the XML file. The Delphi compiler doesn't process any tags but just outputs them to the XML file. </p> <p> Beside the normal usage and behavior, the JediDoc tool has extended the syntax to allow for replacing certain strings with other strings. It does this in two distinct ways: <ul> <li> using arg<i>n</i> attributes, where <i>n</i> can be any integer number. The attribute value will replace any occurance of the <code>{<i>n</i>}</code> string in the included section, including in element or attribute names and attribute values. </li> <li> using the <b>replace</b> tag inside the include element. See the explanation for the <b>replace</b> tag elsewhere in this document. </li> </ul> Note that both ways work with the same list. Therefore, using an <code>arg0</code> attribute would be identical to using a replace element with <code>'{0}'</code> as the search string. Because the replacement list requires unique sources, you can not use both <code>arg0</code> and <code>'{0}'</code>, but <code>arg0</code> and <code>'{1}'</code> would be perfectly valid. </p> <p>Input:</p> <pre><include file="snippets.xml" path="/snippets/commonmembers/*" arg0="Test"> <replace source="{1}"> Replacement for argument <b>1</b>, complete with XML tags. </replace> </include></pre> <p>Output:</p> <p class="prebackgnd"> All child elements of the <b>commonmembers</b> element (which is a child element of the <b>snippets</b> root element). Any occurance of the <code>{0}</code> string in the XML fragment will be replaced with <code>Test</code>. Any occurance of the <code>{1}</code> string in the XML fragment will be replaced with <code>Replacement for argument <b>1</b>, complete with XML tags.</code>. </p> <p> </p> <h2><b>methodref</b></h2> <p> The <b>methodref</b> tag creates a reference to a method. It accepts various attributes that customize the behavior and provide information about what method to create a link to. The <b>methodref</b> tag is a specialized version of the <b>ref</b> base tag. Below a list of attributes. Attributes colored red are required. </p> <p> <ul> <li> Use the <b><i><font color="red">name</font></i></b> attribute (or the <b><i>member</i></b> attribute) to specify the method to reference. This should be the simple method name, without the declaring class name. </li> <li> Use the <b><i>type</i></b> attribute to specify the type in which the method to reference is declared. This should be the namespace-qualified class name. If this attribute is omitted, the type of the current member is assumed. </li> <li> Use the <b><i>reftype</i></b> attribute to specify whether the type should be referenced separately. This should be either <code>1</code>, <code>true</code> or <code>yes</code>; any other value is interpreted as no. If the <b><i>type</i></b> attribute was omitted or equals the current type, this attribute will be ignored. </li> </ul> </p> <p>Input:</p> <pre><member name="M:System.TestClass.MyMethod"> <summary> Calls the <methodref name="MySecondMethod(System.Int32)" /> method. </summary> </member></pre> <p>Output:</p> <pre><member name="M:System.TestClass.MyMethod"> <summary> Calls the <see cref="M:System.TestClass.MySecondMethod(System.Int32)" /> method. </summary> </member></pre> <p> </p> <h2><b>option</b></h2> <p> The first occurance of the <b>option</b> tag within a group will result in its contents being placed inside <b><para></b> tags. Any following occurrence, immediately following the previous one, will also be placed inside <b><para></b> tags, but the fragment <code><para>-or-</para></code> will be added before the new paragraph. </p> <p> There are two additional tags that perform the same expansion: the <b><case></b> tag and the <b><condition></b> tag. Within a group, the three tags can be freely mixed. </p> <p>Input:</p> <pre><returns> <option>An empty string if nothing was found</option> <option>A string representing the found item.</option> </returns></pre> <p>Output:</p> <pre><returns> <para>An empty string if nothing was found</para> <para>-or-</para> <para>A string representing the found item.</para> </returns></pre> <p> </p> <h2><b>propertyref</b></h2> <p> The <b>propertyref</b> tag creates a reference to a property. It accepts various attributes that customize the behavior and provide information about what property to create a link to. The <b>propertyref</b> tag is a specialized version of the <b>ref</b> base tag. Below a list of attributes. Attributes colored red are required. </p> <p> <ul> <li> Use the <b><i><font color="red">name</font></i></b> attribute (or the <b><i>member</i></b> attribute) to specify the property to reference. This should be the simple property name, without the declaring class name. </li> <li> Use the <b><i>type</i></b> attribute to specify the type in which the property to reference is declared. This should be the namespace-qualified class name. If this attribute is omitted, the type of the current member is assumed. </li> <li> Use the <b><i>reftype</i></b> attribute to specify whether the type should be referenced separately. This should be either <code>1</code>, <code>true</code> or <code>yes</code>; any other value is interpreted as no. If the <b><i>type</i></b> attribute was omitted or equals the current type, this attribute will be ignored. </li> </ul> </p> <p>Input:</p> <pre><member name="M:System.TestClass.MyMethod"> <summary> Reads the <propertyref name="MyProperty" /> property to determine whether it should do something. </summary> </member></pre> <p>Output:</p> <pre><member name="M:System.TestClass.MyMethod"> <summary> Reads the <see cref="P:System.TestClass.MyProperty" /> property to determine whether it should do something. </summary> </member></pre> <p> </p> <h2><b>ref</b></h2> <p> The <b>ref</b> tag creates a reference to a member. It accepts various attributes that customize the behavior and provide information about what member to create a link to. The <b>ref</b> tag is the common base tag for the <b>eventref</b>, <b>fieldref</b>, <b>methodref</b>, <b>propertyref</b> and <b>typeref</b> tags, which are specialized versions of this tag. Below a list of attributes. Attributes colored red are required. </p> <p> <ul> <li> Use the <b><i><font color="red">memberType</font></i></b> attribute to specify what type of member to reference. Only the first character of the attribute value is considered, and it must be one of the following: <code>F</code>, <code>E</code>, <code>M</code>, <code>P</code> or <code>T</code>. <li> Use the <b><i><font color="red">member</font></i></b> attribute (or the <b><i>name</i></b> attribute) to specify the property to reference. This should be the simple property name, without the declaring class name. </li> <li> Use the <b><i>type</i></b> attribute to specify the type in which the property to reference is declared. This should be the namespace-qualified class name. If this attribute is omitted, the type of the current member is assumed. </li> <li> Use the <b><i>reftype</i></b> attribute to specify whether the type should be referenced separately. This should be either <code>1</code>, <code>true</code> or <code>yes</code>; any other value is interpreted as no. If the <b><i>type</i></b> attribute was omitted or equals the current type, this attribute will be ignored. </li> </ul> </p> <p>Input:</p> <pre><ref type="T:System.DateTime" member="MaxDate" memberType = "field" reftype="1" /></pre> <p>Output:</p> <pre><see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxDate" /></pre> <p> </p> <h2><b>replace</b></h2> <p> The <b>replace</b> tag is used inside the <b>include</b> tag to specify replacement texts for included snippets. The tag expects a <b><i>source</i></b> attribute specifying the text to find. The contents of the tag will replace any occurance of the search text. </p> <p>For an example, see the explanation of the <b>include</b> tag elsewhere in this document.</p> <p> </p> <h2><b>true-if</b></h2> <p> The <b>true-if</b> tag expands to the common text used to specify when a parameter or return value should be true. The tag requires contents to specify that condition. </p> <p>Input:</p> <pre><true-if>the search should be recursive</true-if></pre> <p>Output:</p> <pre><see langword="true" /> if the search should be recursive; <see langword="false" /> otherwise.</pre> <p> </p> <h2><b>see-class</b></h2> <p>The <b>see-class</b> tag creates a link to the topic page of the current class.</p> <p>Input:</p> <pre><member name="M:System.Class.Method"> <summary> Creates and returns a new instance of the <see-class /> class. </summary> </member></pre> <p>Output:</p> <pre><member name="M:System.Class.Method"> <summary> Creates and returns a new instance of the <see cref="T:System.Class" /> class. </summary> </member></pre> <p> </p> <h2><b>see-ns</b></h2> <p>The <b>see-ns</b> tag creates a link to the topic page of the current namespace.</p> <p>Input:</p> <pre><member name="T:System.Class"> <remarks> Like the other classes in the <see-ns /> namespace, this class does nothing interesting. </remarks> </member></pre> <p>Output:</p> <pre><member name="T:System.Class"> <remarks> Like the other classes in the <see cref="N:System" /> namespace, this class does nothing interesting. </remarks> </member></pre> <p> </p> <h2><b>see-self</b></h2> <p>The <b>see-self</b> tag creates a link to the topic page of the current member.</p> <p>Input:</p> <pre><member name="M:System.Class.Method"> <remarks> The <see-self /> method will create a new instance. </remarks> </member></pre> <p>Output:</p> <pre><member name="M:System.Class.Method"> <remarks> The <see cref="M:System.Class.Method" /> method will create a new instance. </remarks> </member></pre> <p> </p> <h2><b>typeref</b></h2> <p> The <b>typeref</b> tag creates a reference to a type. It accepts various attributes that customize the behavior and provide information about what type to create a link to. The <b>typeref</b> tag is a specialized version of the <b>ref</b> base tag. Below a list of attributes. You need to specify either the <b><i>name</i></b> attribute (to refer to a nested type within the current class) or the <b><i>type</i></b> attribute, though specifying both are allowed (the two values will be concatenated to form the final type to reference). </p> <p> <ul> <li> Use the <b><i>name</i></b> attribute (or the <b><i>member</i></b> attribute) to specify the type to reference. This should be the simple type name, without the declaring class name. </li> <li> Use the <b><i>type</i></b> attribute to specify the type in which the type to reference is declared. This should be the namespace-qualified class name. If this attribute is omitted, the type of the current member is assumed. </li> </ul> </p> <p>Input:</p> <pre><member name="M:System.TestClass.MyMethod"> <summary> Returns a <typeref name="NestedType" />. </summary> </member></pre> <p>Output:</p> <pre><member name="M:System.TestClass.MyMethod"> <summary> Returnss a <see cref="T:System.TestClass.NestedType" />. </summary> </member></pre> <p> </p> </body> </html> Index: frameleft.htm =================================================================== RCS file: /cvsroot/jedidotnet/web/frameleft.htm,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** frameleft.htm 28 Nov 2004 14:49:37 -0000 1.1 --- frameleft.htm 9 Jul 2005 09:34:14 -0000 1.2 *************** *** 14,17 **** --- 14,18 ---- <img border="0" src="images/dot.gif" width="11" height="11"><a href="http://delphi.newswhat.com/geoxml/forumlistgroups?area=JEDI"> Web Newsgroups</a><br> <img border="0" src="images/dot.gif" width="11" height="11"><a href="help/index.html"> Online Help</a><br> + <img border="0" src="images/dot.gif" width="11" height="11"><a href="jedidoc.tags.htm" target="main"> JediDoc tags</a><br> <img border="0" src="images/dot.gif" width="11" height="11"><a href="http://homepages.borland.com/jedi/issuetracker/view_all_bug_page.php"> Bug Tracker</a><br> <img border="0" src="images/dot.gif" width="11" height="11"><a href="http://cvs.sourceforge.net/viewcvs.py/jedidotnet/main/"> Web CVS</a><br> |
