[JEDI.NET-commits] docs Jedi.System.SourceVersioning.xml,1.1,1.2
Status: Pre-Alpha
Brought to you by:
jedi_mbe
From: Marcel B. <jed...@us...> - 2005-03-02 19:15:13
|
Update of /cvsroot/jedidotnet/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4992/docs Modified Files: Jedi.System.SourceVersioning.xml Log Message: * Manual reformatting * All the CVS keyword were expanded. Not a good thing for documentation. Index: Jedi.System.SourceVersioning.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.System.SourceVersioning.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** Jedi.System.SourceVersioning.xml 2 Mar 2005 16:59:37 -0000 1.1 --- Jedi.System.SourceVersioning.xml 2 Mar 2005 19:14:59 -0000 1.2 *************** *** 4,94 **** <member name="T:Jedi.System.CVSSourceInfoAttribute"> <summary> ! Attribute used to provide information on the source file the class, delegate, enumeration, interface or ! structure is declared. ! </summary> <remarks> <para> ! The information this attribute will store include the name of the source file (this may include the path to that ! file), the revision of that file and the date the file was changed last. ! </para> <para> ! This derivative of the <see cref="T:Jedi.System.SourceInfoAttribute" /> is able to parse CVS keywords that (when ! expanded) represent the information required by this attribute. The keywords that can be parsed are: ! <list type="table"><listheader><term>Keyword</term><description>Meaning</description></listheader><item><term>$Id$</term><description><para> ! A string containing all required information using the format ! <c>"$Id$"</c>. ! The <i>revision</i> and <i>date</i> elements are in the same format as their respective keyword ! counterparts, but exclude the keywords themselves (ie. only the revision number and date itself are ! present, not the leading <c>$Revision$Date$</c> sections). ! </para><para><b>Note:</b> The full expansion can contain additional items beyong the user name, but those items are ! ignored. However, the user name, though not used, should be present in the string or an exception will ! be thrown. ! </para></description></item><item><term>$Header$</term><description> ! Like $Id$, but now the full path in the CVS repository for the file is added before the name of the file. ! </description></item><item><term>$Date$</term><description> ! UTC date of last commit using the format ! <c>"$Date$"</c>. The year ! is a four-digit number and month, day, hours, minutes and seconds are two digit numbers. Hours is using ! the 24-hour format. ! </description></item><item><term>$Revision$</term><description> ! Revision number of the file on last commit. It uses the format ! <c>"$Revision$"</c>. The revision can contain any two or more levels, each separated by ! a dot. Each level contains an integer number. ! </description></item><item><term>$RCSfile$</term><description> ! The name of the in the format <c>"$RCSfile$"</c>. It does not contain path ! information. ! </description></item><item><term>$Source$</term><description> ! Like $RCSfile$, but now the full path in the CVS repository for the file is added before the name of the ! file. ! </description></item></list></para> <para> ! The JEDI.NET provides a derived attribute but it is used only to decorate types in the JEDI.NET framework. Its ! only contribution is to automatically ignore part of the path of the file. ! </para> </remarks> <example> <para lang="C#, Visual Basic"> ! This example shows how to provide source file information on the class <c>ExampleClass</c> using the CVS ! keywords. Note that when this file would be committed in CVS, the keywords will be expanded to their correct ! values (assuming that keyword expansion is turned on). Though the example itself compiles as given, attempting ! to retrieve the actual attribute will result in an exception as none of the keywords are expanded. ! </para> <code lang="C#"> ! [CVSSourceInfo("$Source$", "$Revision$", "$Date$")] ! public class ExampleClass ! { ! // insert code here ! } ! </code> <code lang="Visual Basic"> ! <CVSSourceInfo("$Source$", "$Revision$", "$Date$")> ! Public Class ExampleClass ! ' insert code here ! End Class 'ExampleClass ! </code> <para lang="C++, JScript"> ! No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter ! button <IMG SRC="filter1a.gif" ALT="Language Filter" BORDER="0" /> in the upper-left corner of the page. ! </para> </example> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String)"> <overloads> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </overloads> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class by parsing the expanded ! <c>$Id$</c> or <c>$Header$</c> CVS keywords. ! </summary> <param name="id"> ! The expanded <c>$Id$</c> or <c>$Header$</c> CVS keywords from which the file name, revision and last change date ! are taken. ! </param> <remarks> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" />, ! <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> and ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> properties to the corresponding items of the CVS keyword ! specified by the <paramref name="id" /> parameter. ! </remarks> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String,Jedi.System.Revision,System.DateTime)"> --- 4,127 ---- <member name="T:Jedi.System.CVSSourceInfoAttribute"> <summary> ! Attribute used to provide information on the source file the class, delegate, enumeration, interface or ! structure is declared. ! </summary> <remarks> <para> ! The information this attribute will store include the name of the source file (this may include the path to that ! file), the revision of that file and the date the file was changed last. ! </para> <para> ! This derivative of the <see cref="T:Jedi.System.SourceInfoAttribute" /> is able to parse CVS keywords that (when ! expanded) represent the information required by this attribute. The keywords that can be parsed are: ! <list type="table"> ! <listheader> ! <term>Keyword</term> ! <description>Meaning</description> ! </listheader> ! <item> ! <term>Id</term> ! <description> ! <para> ! A string containing all required information using the format ! <c>"Id: <i>filename</i>,v <i>revision</i> <i>date</i> <i>user name</i>"</c>. ! The <i>revision</i> and <i>date</i> elements are in the same format as their respective keyword ! counterparts, but exclude the keywords themselves (ie. only the revision number and date itself are ! present, not the leading <c>Revision: </c> and <c>Date: </c> identifiers). ! </para> ! <para> ! <b>Note:</b> The full expansion can contain additional items beyong the user name, but those items are ! ignored. However, the user name, though not used, should be present in the string or an exception will ! be thrown. ! </para> ! </description> ! </item> ! <item> ! <term>Header</term> ! <description> ! Like the <c>Id</c> keyword, but now the full path in the CVS repository for the file is added before the ! name of the file. ! </description> ! </item> ! <item> ! <term>Date</term> ! <description> ! UTC date of last commit using the format <c>"Date: <i>year</i>/<i>month</i>/<i>day</i> ! <i>hours</i>:<i>minutes</i>:<i>seconds</i>"</c>. The year is a four-digit number and month, day, hours, ! minutes and seconds are two digit numbers. Hours is using the 24-hour format. ! </description> ! </item> ! <item> ! <term>Revision</term> ! <description> ! Revision number of the file on last commit. It uses the format <c>"Revision: <i>revision</i>"</c>. The ! revision can contain two or more levels, each separated by a dot. Each level contains an integer number. ! </description> ! </item> ! <item> ! <term>RCSfile</term> ! <description> ! The name of the in the format <c>"RCSfile: <i>filename</i>,v"</c>. It does not contain path ! information. ! </description> ! </item> ! <item> ! <term>Source</term> ! <description> ! Like the <c>RCSfile</c> keyword, but now the full path in the CVS repository for the file is added before ! the name of the file. ! </description> ! </item> ! </list> ! </para> <para> ! The JEDI.NET provides a derived attribute but it is used only to decorate types in the JEDI.NET framework. Its ! only contribution is to automatically ignore part of the path of the file. ! </para> </remarks> <example> <para lang="C#, Visual Basic"> ! This example shows how to provide source file information on the class <c>ExampleClass</c> using the CVS ! keywords. Note that when this file would be committed in CVS, the keywords will be expanded to their correct ! values (assuming that keyword expansion is turned on). Though the example itself compiles as given, attempting ! to retrieve the actual attribute will result in an exception as none of the keywords are expanded. ! </para> <code lang="C#"> ! [CVSSourceInfo("$Source$", "$Revision$", "$Date$")] ! public class ExampleClass ! { ! // insert code here ! } ! </code> <code lang="Visual Basic"> ! <CVSSourceInfo("$Source$", "$Revision$", "$Date$")> ! Public Class ExampleClass ! ' insert code here ! End Class 'ExampleClass ! </code> <para lang="C++, JScript"> ! No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter ! button <IMG SRC="filter1a.gif" ALT="Language Filter" BORDER="0" /> in the upper-left corner of the page. ! </para> </example> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String)"> <overloads> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </overloads> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class by parsing the expanded ! <c>Id</c> or <c>Header</c> CVS keywords. ! </summary> <param name="id"> ! The expanded <c>Id</c> or <c>Header</c> CVS keywords from which the file name, revision and last change date ! are taken. ! </param> <remarks> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" />, ! <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> and ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> properties to the corresponding items of the CVS keyword ! specified by the <paramref name="id" /> parameter. ! </remarks> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String,Jedi.System.Revision,System.DateTime)"> *************** *** 103,237 **** <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String,System.Int32)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class by parsing the expanded ! <c>$Id$</c> or <c>$Header$</c> CVS keywords and removing a number of directories from the start of the file path. ! </summary> <param name="id"> ! The expanded <c>$Id$</c> or <c>$Header$</c> CVS keywords from which the file name, revision and last change date ! are taken. ! </param> <param name="pathIgnoreLevel"> ! The number of directories to remove from the beginning of the path given in the <paramref name="sourceFile" /> ! parameter. ! </param> <remarks> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" />, ! <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> and ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> properties to the corresponding items of the CVS keyword ! specified by the <paramref name="id" /> parameter. ! </remarks> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String,System.String,System.String)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class by parsing CVS expanded ! keywords. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! This parameter should be set to the <c>$RCSfile$</c> or <c>$Source$</c> tags, where the CVS system will expand ! it to the actual file name once the file is committed. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </para> <para> ! This parameter should be set to the <c>$Revision$</c> tag, where the CVS system will expand it to the actual ! file revision each time it is committed. ! </para> </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! This parameter should be set to the <c>$Date$</c> tag, where the CVS system will expand it to the actual ! UTC date and time each time the file is committed. ! </para> </param> <remarks> <para> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> ! parameter. ! </para> <para> ! If you don't specify the CVS keyword for a parameter, that parameter is parsed as if it contains the actual ! value for the parameter, that is, the value is handed over to the ! <see cref="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,System.String,System.String)" /> without any ! processing on it. ! </para> </remarks> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String,System.String,System.String,System.Int32)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class by parsing CVS expanded ! keywords and removing a number of directories from the start of the file path. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! This parameter should be set to the <c>$RCSfile$</c> or <c>$Source$</c> tags, where the CVS system will expand ! it to the actual file name once the file is committed. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </para> <para> ! This parameter should be set to the <c>$Revision$</c> tag, where the CVS system will expand it to the actual ! file revision each time it is committed. ! </para> </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! This parameter should be set to the <c>$Date$</c> tag, where the CVS system will expand it to the actual ! UTC date and time each time the file is committed. ! </para> </param> <param name="pathIgnoreLevel"> ! The number of directories to remove from the beginning of the path given in the <paramref name="sourceFile" /> ! parameter. ! </param> <remarks> <para> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> ! parameter. ! </para> <para> ! If you don't specify the CVS keyword for a parameter, that parameter is parsed as if it contains the actual ! value for the parameter, that is, the value is handed over to the ! <see cref="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,System.String,System.String)" /> without any ! processing on it. The value of <paramref name="pathIgnoreLevel" /> will be applied to the value of ! <paramref name="sourceFile" />, regardless of the presence of a CVS keyword. ! </para> </remarks> </member> --- 136,270 ---- <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String,System.Int32)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class by parsing the expanded ! <c>Id</c> or <c>Header</c> CVS keywords and removing a number of directories from the start of the file path. ! </summary> <param name="id"> ! The expanded <c>Id</c> or <c>Header</c> CVS keywords from which the file name, revision and last change date ! are taken. ! </param> <param name="pathIgnoreLevel"> ! The number of directories to remove from the beginning of the path given in the <paramref name="sourceFile" /> ! parameter. ! </param> <remarks> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" />, ! <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> and ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> properties to the corresponding items of the CVS keyword ! specified by the <paramref name="id" /> parameter. ! </remarks> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String,System.String,System.String)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class by parsing CVS expanded ! keywords. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! This parameter should be set to the <c>RCSfile</c> or <c>Source</c> tags, where the CVS system will expand ! it to the actual file name once the file is committed. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </para> <para> ! This parameter should be set to the <c>Revision</c> tag, where the CVS system will expand it to the actual ! file revision each time it is committed. ! </para> </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! This parameter should be set to the <c>Date</c> tag, where the CVS system will expand it to the actual ! UTC date and time each time the file is committed. ! </para> </param> <remarks> <para> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> ! parameter. ! </para> <para> ! If you don't specify the CVS keyword for a parameter, that parameter is parsed as if it contains the actual ! value for the parameter, that is, the value is handed over to the ! <see cref="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,System.String,System.String)" /> without any ! processing on it. ! </para> </remarks> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.#ctor(System.String,System.String,System.String,System.Int32)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class by parsing CVS expanded ! keywords and removing a number of directories from the start of the file path. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! This parameter should be set to the <c>RCSfile</c> or <c>Source</c> tags, where the CVS system will expand ! it to the actual file name once the file is committed. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </para> <para> ! This parameter should be set to the <c>Revision</c> tag, where the CVS system will expand it to the actual ! file revision each time it is committed. ! </para> </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! This parameter should be set to the <c>Date</c> tag, where the CVS system will expand it to the actual ! UTC date and time each time the file is committed. ! </para> </param> <param name="pathIgnoreLevel"> ! The number of directories to remove from the beginning of the path given in the <paramref name="sourceFile" /> ! parameter. ! </param> <remarks> <para> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> ! parameter. ! </para> <para> ! If you don't specify the CVS keyword for a parameter, that parameter is parsed as if it contains the actual ! value for the parameter, that is, the value is handed over to the ! <see cref="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,System.String,System.String)" /> without any ! processing on it. The value of <paramref name="pathIgnoreLevel" /> will be applied to the value of ! <paramref name="sourceFile" />, regardless of the presence of a CVS keyword. ! </para> </remarks> </member> *************** *** 393,403 **** </member> <member name="M:Jedi.System.Revision.Equals(System.Object)"> ! <!--Optional member; you're not required to document this member--> ! <summary> ! </summary> ! <param name="obj"> ! </param> ! <returns> ! </returns> </member> <member name="M:Jedi.System.Revision.IsSubBranchOf(Jedi.System.Revision)"> --- 426,430 ---- </member> <member name="M:Jedi.System.Revision.Equals(System.Object)"> ! <exclude /> </member> <member name="M:Jedi.System.Revision.IsSubBranchOf(Jedi.System.Revision)"> *************** *** 418,426 **** </member> <member name="M:Jedi.System.Revision.ToString"> ! <!--Optional member; you're not required to document this member--> ! <summary> ! </summary> ! <returns> ! </returns> </member> <member name="T:Jedi.System.SourceInfo"> --- 445,449 ---- </member> <member name="M:Jedi.System.Revision.ToString"> ! <exclude /> </member> <member name="T:Jedi.System.SourceInfo"> *************** *** 494,569 **** <member name="T:Jedi.System.SourceInfoAttribute"> <summary> ! Base attribute used to provide information on the source file the class, delegate, enumeration, interface or ! structure is declared. ! </summary> <remarks> <para> ! The information this attribute will store include the name of the source file (this may include the path to that ! file), the revision of that file and the date the file was changed last. ! </para> <para> ! While this attribute can be used as is, a number of derived ones are provided that extend and/or simplify ! usage. For example, there's a derived attribute provided that will automate creating the attribute by using CVS ! keyword expansion. ! </para> </remarks> <example> <para lang="C#, Visual Basic"> ! This example shows how to provide source file information on the class <c>ExampleClass</c>. ! </para> <code lang="C#"> ! [SourceInfo("path/to/file.cs", "2.13", "2005/01/17")] ! public class ExampleClass ! { ! // insert code here ! } ! </code> <code lang="Visual Basic"> ! <SourceInfo("path/to/file.cs", "2.13", "2005/01/17")> ! Public Class ExampleClass ! ' insert code here ! End Class 'ExampleClass ! </code> <para lang="C++, JScript"> ! No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter ! button <IMG SRC="filter1a.gif" ALT="Language Filter" BORDER="0" /> in the upper-left corner of the page. ! </para> </example> </member> <member name="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,Jedi.System.Revision,System.DateTime)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </param> <param name="date"> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </param> <remarks> <para> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> ! parameter. ! </para> <para> <note type="caution"> ! This overloaded version of the constructor can not be used when decorating a type with this attribute. It is ! provided as a convienience constructor when constructing this attribute at run time. ! </note> </para> </remarks> --- 517,592 ---- <member name="T:Jedi.System.SourceInfoAttribute"> <summary> ! Base attribute used to provide information on the source file the class, delegate, enumeration, interface or ! structure is declared. ! </summary> <remarks> <para> ! The information this attribute will store include the name of the source file (this may include the path to that ! file), the revision of that file and the date the file was changed last. ! </para> <para> ! While this attribute can be used as is, a number of derived ones are provided that extend and/or simplify ! usage. For example, there's a derived attribute provided that will automate creating the attribute by using CVS ! keyword expansion. ! </para> </remarks> <example> <para lang="C#, Visual Basic"> ! This example shows how to provide source file information on the class <c>ExampleClass</c>. ! </para> <code lang="C#"> ! [SourceInfo("path/to/file.cs", "2.13", "2005/01/17")] ! public class ExampleClass ! { ! // insert code here ! } ! </code> <code lang="Visual Basic"> ! <SourceInfo("path/to/file.vb", "2.13", "2005/01/17")> ! Public Class ExampleClass ! ' insert code here ! End Class 'ExampleClass ! </code> <para lang="C++, JScript"> ! No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter ! button <IMG SRC="filter1a.gif" ALT="Language Filter" BORDER="0" /> in the upper-left corner of the page. ! </para> </example> </member> <member name="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,Jedi.System.Revision,System.DateTime)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </param> <param name="date"> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </param> <remarks> <para> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> ! parameter. ! </para> <para> <note type="caution"> ! This overloaded version of the constructor can not be used when decorating a type with this attribute. It is ! provided as a convienience constructor when constructing this attribute at run time. ! </note> </para> </remarks> *************** *** 571,613 **** <member name="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,Jedi.System.Revision,System.String)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! The date string is parsed using the format <c>"yyyy'/'MM'/'dd HH':'mm':'ss"</c> using ! <see cref="M:System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider)" />. ! </para> </param> <remarks> <para> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> ! parameter. ! </para> <para> <note type="caution"> ! This overloaded version of the constructor can not be used when decorating a type with this attribute. It is ! provided as a convienience constructor when constructing this attribute at run time. ! </note> </para> </remarks> --- 594,636 ---- <member name="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,Jedi.System.Revision,System.String)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! The date string is parsed using the format <c>"yyyy'/'MM'/'dd HH':'mm':'ss"</c> using ! <see cref="M:System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider)" />. ! </para> </param> <remarks> <para> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> ! parameter. ! </para> <para> <note type="caution"> ! This overloaded version of the constructor can not be used when decorating a type with this attribute. It is ! provided as a convienience constructor when constructing this attribute at run time. ! </note> </para> </remarks> *************** *** 615,703 **** <member name="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,System.Double,System.String)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! The date string is parsed using the format <c>"yyyy'/'MM'/'dd HH':'mm':'ss"</c> using ! <see cref="M:System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider)" />. ! </para> </param> <remarks> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> parameter. ! </remarks> </member> <member name="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,System.String,System.String)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </para> <para> ! Revision numbers can only contain digits and the dot character but can have any depth. For example both ! <c>"159"</c> and <c>"3.0.12.2"</c> are valid revision numbers. ! </para> </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! The date string is parsed using the format <c>"yyyy'/'MM'/'dd HH':'mm':'ss"</c> using ! <see cref="M:System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider)" />. ! </para> </param> <remarks> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> parameter. ! </remarks> </member> <member name="P:Jedi.System.SourceInfoAttribute.Date"> <summary> ! The date the source file was last modified. ! </summary> <value> ! A <see cref="T:System.DateTime" /> representing the date of the last modification of the source file. ! </value> <remarks> ! By convention, this date is assumed to be an UTC date. This, however, is not guaranteed and is solely dependant on ! what the developers chose when specifying the date and time or the way the derived attributes parse this date. ! </remarks> </member> <member name="F:Jedi.System.SourceInfoAttribute.dateFormat"> --- 638,726 ---- <member name="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,System.Double,System.String)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! The date string is parsed using the format <c>"yyyy'/'MM'/'dd HH':'mm':'ss"</c> using ! <see cref="M:System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider)" />. ! </para> </param> <remarks> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> parameter. ! </remarks> </member> <member name="M:Jedi.System.SourceInfoAttribute.#ctor(System.String,System.String,System.String)"> <summary> ! Initializes a new instance of the <see cref="T:Jedi.System.SourceInfoAttribute" /> class. ! </summary> <param name="sourceFile"> <para> ! Value for the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property. This represents the source ! file (optionally including a (relative) path to it) the type is declared in. ! </para> <para> ! Any occurances of the <see cref="F:System.IO.Path.AltDirectorySeperatorChar" /> character will be converted into ! the <see cref="F:System.IO.Path.DirectorySeperatorChar" /> character before the property value is stored. ! </para> </param> <param name="revision"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> property. This represents the ! numerical revision number of the source file. ! </para> <para> ! Revision numbers can only contain digits and the dot character but can have any depth. For example both ! <c>"159"</c> and <c>"3.0.12.2"</c> are valid revision numbers. ! </para> </param> <param name="date"> <para> ! The value for the <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property. This represents the ! date the file was last changed. ! </para> <para> ! The date string is parsed using the format <c>"yyyy'/'MM'/'dd HH':'mm':'ss"</c> using ! <see cref="M:System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider)" />. ! </para> </param> <remarks> ! The instance will initialize the <see cref="P:Jedi.System.SourceInfoAttribute.SourceFile" /> property to the ! specified <paramref name="sourceFile" /> parameter, the <see cref="P:Jedi.System.SourceInfoAttribute.Revision" /> ! property to the specified <paramref name="Revision" /> parameter and the ! <see cref="P:Jedi.System.SourceInfoAttribute.Date" /> property to the specified <paramref name="date" /> parameter. ! </remarks> </member> <member name="P:Jedi.System.SourceInfoAttribute.Date"> <summary> ! The date the source file was last modified. ! </summary> <value> ! A <see cref="T:System.DateTime" /> representing the date of the last modification of the source file. ! </value> <remarks> ! By convention, this date is assumed to be an UTC date. This, however, is not guaranteed and is solely dependant on ! what the developers chose when specifying the date and time or the way the derived attributes parse this date. ! </remarks> </member> <member name="F:Jedi.System.SourceInfoAttribute.dateFormat"> *************** *** 707,723 **** <member name="P:Jedi.System.SourceInfoAttribute.Revision"> <summary> ! The revision of the source file. ! </summary> <value> ! A <see cref="TJedi.System.Revision" /> representing the revision of the source file. ! </value> </member> <member name="P:Jedi.System.SourceInfoAttribute.SourceFile"> <summary> ! The path (optionally) and name of the source file. ! </summary> <value> ! A <see cref="T:System.String" /> representing the optional path and name of the source file. ! </value> </member> </members> \ No newline at end of file --- 730,746 ---- <member name="P:Jedi.System.SourceInfoAttribute.Revision"> <summary> ! The revision of the source file. ! </summary> <value> ! A <see cref="TJedi.System.Revision" /> representing the revision of the source file. ! </value> </member> <member name="P:Jedi.System.SourceInfoAttribute.SourceFile"> <summary> ! The path (optionally) and name of the source file. ! </summary> <value> ! A <see cref="T:System.String" /> representing the optional path and name of the source file. ! </value> </member> </members> \ No newline at end of file |