[JEDI.NET-commits] docs Jedi.System.SourceVersioning.xml,1.2,1.3
Status: Pre-Alpha
Brought to you by:
jedi_mbe
Menu
▾
▴
[JEDI.NET-commits] docs Jedi.System.SourceVersioning.xml,1.2,1.3
|
From: Marcel B. <jed...@us...> - 2005-03-03 09:39:03
|
Update of /cvsroot/jedidotnet/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19309/docs Modified Files: Jedi.System.SourceVersioning.xml Log Message: * Malformed XML corrected * Restored '$' around the CVS keywords (using $ entities) Index: Jedi.System.SourceVersioning.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.System.SourceVersioning.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** Jedi.System.SourceVersioning.xml 2 Mar 2005 19:14:59 -0000 1.2 --- Jedi.System.SourceVersioning.xml 3 Mar 2005 09:38:53 -0000 1.3 *************** *** 21,35 **** </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. --- 21,35 ---- </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 beyond 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. *************** *** 38,74 **** </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> --- 38,75 ---- </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> *************** *** 88,92 **** </para> <code lang="C#"> ! [CVSSourceInfo("$Source$", "$Revision$", "$Date$")] public class ExampleClass { --- 89,93 ---- </para> <code lang="C#"> ! [CVSSourceInfo("$Source$", "$Revision$", "$Date$")] public class ExampleClass { *************** *** 95,99 **** </code> <code lang="Visual Basic"> ! <CVSSourceInfo("$Source$", "$Revision$", "$Date$")> Public Class ExampleClass ' insert code here --- 96,100 ---- </code> <code lang="Visual Basic"> ! <CVSSourceInfo("$Source$", "$Revision$", "$Date$")> Public Class ExampleClass ' insert code here *************** *** 112,120 **** <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> --- 113,121 ---- <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> *************** *** 137,145 **** <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"> --- 138,147 ---- <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"> *************** *** 165,170 **** </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> --- 167,172 ---- </para> <para> ! This parameter should be set to the <c>$RCSfile$</c> or <c>$Source$</c> keyword, where the CVS ! system will expand it to the actual file name once the file is committed. </para> <para> *************** *** 179,184 **** </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> --- 181,186 ---- </para> <para> ! This parameter should be set to the <c>$Revision$</c> keyword, where the CVS system will expand it to ! the actual file revision each time it is committed. </para> </param> *************** *** 189,194 **** </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> --- 191,196 ---- </para> <para> ! This parameter should be set to the <c>$Date$</c> keyword, where the CVS system will expand it to the ! actual UTC date and time each time the file is committed. </para> </param> *************** *** 220,225 **** </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> --- 222,227 ---- </para> <para> ! This parameter should be set to the <c>$RCSfile$</c> or <c>$Source$</c> keywords, where the CVS ! system will expand it to the actual file name once the file is committed. </para> <para> *************** *** 234,239 **** </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> --- 236,241 ---- </para> <para> ! This parameter should be set to the <c>$Revision$</c> keyword, where the CVS system will expand it to ! the actual file revision each time it is committed. </para> </param> *************** *** 244,249 **** </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> --- 246,251 ---- </para> <para> ! This parameter should be set to the <c>$Date$</c> keyword, where the CVS system will expand it to the ! actual UTC date and time each time the file is committed. </para> </param> *************** *** 271,298 **** --- 273,318 ---- <member name="M:Jedi.System.CVSSourceInfoAttribute.ParseDate(System.String)"> <summary> + Parses the given string to obtain the date. </summary> <param name="date"> + <see cref="T:System.String" /> to parse for the date. It must be in the format <i>year</i>/<i>month</i>/<i>day</i> + <i>hours</i>:<i>minutes</i>:<i>seconds</i>, optionally prefixed with <c>$Date: </c> and suffixed with a + <c> $</c>. </param> <returns> + A <see cref="T:System.DateTime" /> of the date time represented by the <paramref name="date" /> parameter. </returns> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.ParseId(System.String,System.String@,Jedi.System.Revision@,System.DateTime@)"> <summary> + Parses the given string to obtain the file name, revision and date. </summary> <param name="id"> + A <see cref="T:System.String" /> containing an expanded <c>$Id$</c> or <c>$Header$</c> CVS + keyword. It will be parsed into its file name, revision an date parts. </param> <param name="source"> + A <see cref="T:System.String" /> variable to receive the file name in. Depending on which CVS keyword specified + in the <paramref name="id" /> parameter, this may contain a full path or just a file name. </param> <param name="revision"> + A <see cref="T:Jedi.System.Revision" /> variable to receive the revision number in. </param> <param name="date"> + A <see cref="T:System.DateTime" /> variable to receive the date and time in. </param> </member> <member name="M:Jedi.System.CVSSourceInfoAttribute.ParseRevision(System.String)"> <summary> + Parses the given string to obtain the revision number. </summary> <param name="revision"> + A <see cref="T:System.String" /> to parse for the revision number. It must be in the format + <c><i>integer</i>.<i>integer</i></c>, optionally followed by more <c>.<i>integer</i></c> elements. Spaces + between the elements are not allowed. The string may be prefixed with a <c>$Revision: </c> and suffixed with a + <c> $</c>. </param> <returns> + A <see cref="T:Jedi.System.Revision" /> of the revision represented by the <paramref name="revision" /> parameter. </returns> </member> *************** *** 307,316 **** --- 327,342 ---- <member name="M:Jedi.System.CVSSourceInfoAttribute.RemovePathLevels(System.String,System.Int32)"> <summary> + Removes a number of directories from the start of a path. </summary> <param name="path"> + The path from which to remove directories. </param> <param name="levels"> + The number of directories to remove. The specified number will be removed from the start of the string specified + in the <paramref name="path" />. </param> <returns> + A <see cref="T:System.String" /> with the first <paramref name="levels" /> directories removed from + <paramref name="path" />. </returns> </member> |
