[JEDI.NET-commits] docs Jedi.System.CommandLine.xml,1.6,1.7
Status: Pre-Alpha
Brought to you by:
jedi_mbe
Menu
▾
▴
[JEDI.NET-commits] docs Jedi.System.CommandLine.xml,1.6,1.7
|
From: Marcel B. <jed...@us...> - 2005-03-12 18:08:55
|
Update of /cvsroot/jedidotnet/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29901/docs Modified Files: Jedi.System.CommandLine.xml Log Message: Completed documentation (though some items deserve more explanation) Index: Jedi.System.CommandLine.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.System.CommandLine.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -d -r1.6 -r1.7 *** Jedi.System.CommandLine.xml 12 Mar 2005 13:11:29 -0000 1.6 --- Jedi.System.CommandLine.xml 12 Mar 2005 18:08:43 -0000 1.7 *************** *** 90,98 **** --- 90,198 ---- <member name="M:Jedi.System.CommandLine.Argument.CompareTo(System.Object)"> <summary> + Compares this instance to a specified object and returns an indication of their relative values. </summary> <param name="obj"> + An object to compare to this instance, or a <see langword="null" />. </param> <returns> + A signed integer that indicates the relative order of this instance and <paramref name="obj" />. + <list type="table"> + <listheader> + <term>Return Value</term> + <description>Condition</description> + </listheader> + <item> + <term>Less than zero</term> + <description> + <para> + <paramref name="obj" /> is a <see cref="T:Jedi.System.CommandLine.Argument" /> and this instance's + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see> is less than that of + <paramref name="obj" />. If either instance is not case-sensitive + (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is <see langword="false" />) the case of + the two strings will have been ignored. + </para> + <para> + -or- + </para> + <para> + <paramref name="obj" /> is a <see cref="T:System.String" /> and this instance's + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see> is less than the specified + string (limited to the length of the + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see>). If the instance is not + case-sensitive (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is + <see langword="false" />) the case of the two strings will have been ignored. + </para> + </description> + </item> + <item> + <term>Zero</term> + <description> + <para> + <paramref name="obj" /> is a <see cref="T:Jedi.System.CommandLine.Argument" /> and two instance's + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match strings</see> are equal. If either instance + is not case-sensitive (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is + <see langword="false" />) the case of the two strings will have been ignored. + </para> + <para> + -or- + </para> + <para> + <paramref name="obj" /> is a <see cref="T:System.String" /> and this instance's + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see> equals the specified + string (limited to the length of the + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see>). If the instance is not + case-sensitive (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is + <see langword="false" />) the case of the two strings will have been ignored. + </para> + </description> + </item> + <item> + <term>Greater than zero</term> + <description> + <para> + <paramref name="obj" /> is a <see cref="T:Jedi.System.CommandLine.Argument" /> and this instance's + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see> is greater than that of + <paramref name="obj" />. If either instance is not case-sensitive + (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is <see langword="false" />) the case of + the two strings will have been ignored. + </para> + <para> + -or- + </para> + <para> + <paramref name="obj" /> is a <see cref="T:System.String" /> and this instance's + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see> is greater than the specified + string (limited to the length of the + <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see>). If the instance is not + case-sensitive (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is + <see langword="false" />) the case of the two strings will have been ignored. + </para> + <para> + -or- + </para> + <para> + <paramref name="obj" /> is a <see langword="null" />. + </para> + </description> + </item> + </list> </returns> + <remarks> + <para> + <paramref name="obj" /> must be a <see langword="null" />, an instance of + <see cref="T:Jedi.System.CommandLine.Argument" /> or an instance of <see cref="T:System.String" />; otherwise an + exception is thrown. + </para> + <para> + If <paramref name="obj" /> is a <see cref="T:System.String" />, it will be limited in length to the length of + the <see cref="P:Jedi.System.CommandLine.Argument.Matches">match string</see> of this instance. The + <see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> property determines if the comparison will + ignore casing differences. + </para> + </remarks> + <exception cref="T:System.ArgumentException"> + <paramref name="obj" /> is not a <see langword="null" />, an instance of + <see cref="T:Jedi.System.CommandLine.Argument" /> or an instance of <see cref="T:System.String" />. + </exception> </member> <member name="P:Jedi.System.CommandLine.Argument.Instance"> *************** *** 319,324 **** --- 419,427 ---- <member name="M:Jedi.System.CommandLine.GetLiterals"> <summary> + Retrieve the literals found on the command line. </summary> <returns> + An array of <see cref="T:System.String" /> containing all non-switch arguments found on the command line and/or + in parsed response files. </returns> </member> *************** *** 344,348 **** </param> <returns> ! A list of <see cref="T:System.String" /> found on the command line that could not be switches. </returns> </member> --- 447,451 ---- </param> <returns> ! An array of <see cref="T:System.String" /> containing all non-switch arguments found on the command line. </returns> </member> *************** *** 360,364 **** </param> <returns> ! A list of <see cref="T:System.String" /> found on the command line that could not be switches or a response file. </returns> </member> --- 463,468 ---- </param> <returns> ! An array of <see cref="T:System.String" /> containing all non-switch arguments found on the command line and/or ! in parsed response files. </returns> </member> *************** *** 375,379 **** </param> <returns> ! A list of <see cref="T:System.String" /> found on the command line that could not be switches. </returns> </member> --- 479,483 ---- </param> <returns> ! An array of <see cref="T:System.String" /> containing all non-switch arguments found on the command line. </returns> </member> *************** *** 393,397 **** </param> <returns> ! A list of <see cref="T:System.String" /> found on the command line that could not be switches or a response file. </returns> </member> --- 497,502 ---- </param> <returns> ! An array of <see cref="T:System.String" /> containing all non-switch arguments found on the command line and/or ! in parsed response files. </returns> </member> *************** *** 405,415 **** --- 510,535 ---- </member> <member name="M:Jedi.System.CommandLine.RegisterArgument(System.Object,System.Reflection.MemberInfo,Jedi.System.CommandLineArgumentAttribute)"> + <overloads> + Registers an argument. + </overloads> <summary> + Registers an argument given a <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute. </summary> <param name="instance"> + <para> + The instance the member belongs to. + </para> + <para> + -or- + </para> + <para> + A <see langword="null" /> if the specified member is <see langword="static" />. + </para> </param> <param name="memberInfo"> + The method or property to register. </param> <param name="attr"> + The attribute that decorated the member to register. </param> </member> *************** *** 418,451 **** --- 538,619 ---- </summary> <param name="instance"> + <para> + The instance the member belongs to. + </para> + <para> + -or- + </para> + <para> + A <see langword="null" /> if the specified member is <see langword="static" />. + </para> </param> <param name="memberInfo"> + The method or property to register. </param> <param name="attributes"> + List of <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attributes decorating this member. </param> </member> <member name="M:Jedi.System.CommandLine.RegisterInstance(System.Object)"> <summary> + Registers all methods and properties decorated by a <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> + attribute on the specified instance or <see cref="T:System.Type" />. </summary> <param name="instance"> + <para> + A <see cref="T:System.Type" /> to register <see langword="static" /> properties and methods of. + </para> + <para> + -or- + </para> + <para> + Any instance to register instance properties and methods of. + </para> </param> </member> <member name="M:Jedi.System.CommandLine.RegisterInstances(System.Object[])"> <summary> + Registers all methods and properties decorated by a <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> + attribute on the specified instances and/or <see cref="T:System.Type" />s. </summary> <param name="instances"> + An array of instances or <see cref="T:System.Type" />s to register. The array can contain both instances and + <see cref="T:System.Type" />s. </param> </member> <member name="M:Jedi.System.CommandLine.RegisterType(System.Type)"> + <overloads> + Registers all methods and properties decorated by a <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> + attribute on the specified instances and/or <see cref="T:System.Type" />s. + </overloads> <summary> + Registers the <see langword="static" /> properties and methods decorated by a + <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute on the specified <see cref="T:System.Type" />. </summary> <param name="type"> + The type to scan for properties/methods decorated by the <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> + attribute. </param> </member> <member name="M:Jedi.System.CommandLine.RegisterType(System.Type,System.Object)"> <summary> + Registers the <see langword="static" /> or instance properties and methods decorated by a + <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute on the specified <see cref="T:System.Type" /> + and/or instance. </summary> <param name="type"> + The type to scan for properties/methods decorated by the <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> + attribute. </param> <param name="instance"> + <para> + An instance of the type specifified by <paramref name="type" />. + </para> + <para> + -or- + </para> + <para> + A <see langword="null" />. + </para> </param> </member> |
