[JEDI.NET-commits] docs Jedi.System.CommandLine.xml,1.2,1.3

[Marcel B. <jed...@us...>]

Update of /cvsroot/jedidotnet/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12656/docs

Modified Files:
	Jedi.System.CommandLine.xml 
Log Message:
Partially documented.

Index: Jedi.System.CommandLine.xml
===================================================================
RCS file: /cvsroot/jedidotnet/docs/Jedi.System.CommandLine.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Jedi.System.CommandLine.xml	5 Mar 2005 19:18:19 -0000	1.2
--- Jedi.System.CommandLine.xml	7 Mar 2005 14:22:46 -0000	1.3
***************
*** 4,39 ****
--- 4,79 ----
    <member name="T:Jedi.System.CommandLine">
      <summary>
+       A command line parser.
      </summary>
    </member>
    <member name="M:Jedi.System.CommandLine.#ctor(System.Object[],System.String)">
      <summary>
+       Initializes a new instance of the <see cref="T:Jedi.System.CommandLine" /> class.
      </summary>
      <param name="arguments">
+       A list of instances or <see cref="T:System.Type" />s to scan for properties and methods
+       decoracted with the <see cref="T:Jedi.System.CommandLineArgumentAttribute" />
      </param>
      <param name="responseFilePrefix">
+       The match string to indicate the character or switch used to parse a response file.
      </param>
    </member>
    <member name="M:Jedi.System.CommandLine.AddLiteral(System.String,System.Int32)">
      <summary>
+       Adds a literal command line argument to the list of literals.
      </summary>
      <param name="commandLine">
+       The complete command line.
      </param>
      <param name="index">
+       <para>
+         Upon entry to the method, points to the 0-based index into the <paramref name="commandLine" /> parameter at
+         which the literal starts.
+       </para>
+       <para>
+         Upon leaving the method, the index should be pointing to the next argument.
+       </para>
      </param>
+     <remarks>
+       <para>
+         A literal is considered to be anything that can't be seens a possible switch or option. The parser considers any
+         of the prefix characters as a possible switch, where only the first character of a prefix string with more than
+         one character is considered.
+       </para>
+       <para>
+         The list of literals is returned by any of the <see cref="M:Jedi.System.CommandLine.Parse" /> methods.
+       </para>
+     </remarks>
    </member>
    <member name="T:Jedi.System.CommandLine.Argument">
      <summary>
+       Class used to specify an individual comand line switch.
      </summary>
    </member>
    <member name="M:Jedi.System.CommandLine.Argument.#ctor(System.String,System.Boolean,System.Object,System.Reflection.MemberInfo)">
      <summary>
+       Initializes a new instance of the <see cref="T:Jedi.System.CommandLine.Argument" /> class.
      </summary>
      <param name="matches">
+       The string to match on the command line. This will be the concatenation of the prefix, name and value separator
+       strings specified by the <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute.
      </param>
      <param name="caseSensitive">
+       Indicates whether the case should be considered when matching against the command line.
      </param>
      <param name="instance">
+       <para>
+         The instance to which the property or method for this switch belongs.
+       </para>
+       <para>
+         -or-
+       </para>
+       <para>
+         A <see langword="null" /> if the property or method is <see langword="static" /> to the
+         <see cref="T:System.Type" />.
+       </para>
      </param>
      <param name="memberInfo">
+       The method or property this switch is linked to.
      </param>
    </member>
***************
*** 145,148 ****
--- 185,190 ----
    </member>
    <member name="M:Jedi.System.CommandLine.Parse(System.Object[])">
+     <overloads>
+     </overloads>
      <summary>
      </summary>
***************
*** 238,340 ****
    <member name="T:Jedi.System.CommandLineArgumentAttribute">
      <summary>
      </summary>
    </member>
    <member name="M:Jedi.System.CommandLineArgumentAttribute.#ctor">
      <summary>
      </summary>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.CaseSensitive">
      <summary>
      </summary>
      <value>
      </value>
    </member>
    <member name="M:Jedi.System.CommandLineArgumentAttribute.GetMatches">
      <summary>
      </summary>
      <returns>
      </returns>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.Name">
      <summary>
      </summary>
      <value>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.NameCount">
      <summary>
      </summary>
      <value>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.Names(System.Int32)">
      <summary>
      </summary>
      <param name="index">
      </param>
      <value>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.Prefix">
      <summary>
      </summary>
      <value>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.PrefixCount">
      <summary>
      </summary>
      <value>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.Prefixes(System.Int32)">
      <summary>
      </summary>
      <param name="index">
      </param>
      <value>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparator">
      <summary>
      </summary>
      <value>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparatorCount">
      <summary>
      </summary>
      <value>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparators(System.Int32)">
      <summary>
      </summary>
      <param name="index">
      </param>
      <value>
      </value>
    </member>
    <member name="T:Jedi.System.CommandLineException">
      <summary>
      </summary>
    </member>
    <member name="M:Jedi.System.CommandLineException.#ctor">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.System.CommandLineException.#ctor(System.String)">
!     <summary>
!     </summary>
!     <param name="message">
!     </param>
    </member>
    <member name="M:Jedi.System.CommandLineException.#ctor(System.String,System.Exception)">
!     <summary>
!     </summary>
!     <param name="message">
!     </param>
!     <param name="innerException">
!     </param>
    </member>
  </members>
\ No newline at end of file
--- 280,476 ----
    <member name="T:Jedi.System.CommandLineArgumentAttribute">
      <summary>
+       Attribute used to provide information on the command line argument(s) this property or method refers to.
      </summary>
+     <remarks>
+       <para>
+         The attribute can be attached to either a method or a property. In case of a method, the method will be
+         processing any value provided on the commandline on its own. For properties, the parser processes the value
+         provided on the command line based on the type of property.
+       </para>
+       <para>
+         The constructor does not provide any parameters. Values are set by setting certain properties of the attribute.
+         In addition, you're allowed to provided multiple instances of this attribute for more flexability.
+       </para>
+       <para>
+         Each instance of the attribute can define any number of command line switches to recognise and link to the
+         property or method.
+       </para>
+     </remarks>
    </member>
    <member name="M:Jedi.System.CommandLineArgumentAttribute.#ctor">
      <summary>
+       Initializes a new instance of the <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> class.
      </summary>
+     <remarks>
+       <para>
+         The constructor does not provide any parameters. Values are set by setting certain properties of the attribute.
+       </para>
+     </remarks>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.CaseSensitive">
      <summary>
+     	Specifies if matching of the command line switch should be done case sensitive.
      </summary>
      <value>
+       <see langword="true" /> if matching this/these switch(es) to the command line should be done case sensitive;
+       otherwise, <see langword="false" />. It defaults to <see langword="false" />.
      </value>
+     <remarks>
+       This property is global to this instance. Every switch name specified will be matched case sensitive or not
+       depending on the value of this property. Setting this value multiple times to different settings will influence
+       every switch name already registered.
+     </remarks>
    </member>
    <member name="M:Jedi.System.CommandLineArgumentAttribute.GetMatches">
      <summary>
+     	Retrieve a list of matches.
      </summary>
      <returns>
+       A <see cref="T:System.String" /> array containing all the match strings this argument should match.
      </returns>
+     <remarks>
+       <para>
+         The list will contain all permutations of combinations of the
+         <see cref="P:Jedi.System.CommandLineArgumentAttribute.Names(System.Int32)" />,
+         <see cref="P:Jedi.System.CommandLineArgumentAttribute.Prefixes(System.Int32)" /> and
+         <see cref="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparators(System.Int32)" /> properties.
+       </para>
+       <para>
+         The value of <see cref="P:Jedi.System.CommandLineArgumentAttribute.CaseSensitive" /> has no influence on this
+         list.
+       </para>
+       <para>
+         If the <see cref="P:Jedi.System.CommandLineArgumentAttribute.Names(System.Int32)" /> list is empty, the returned
+         list will also be empty.
+       </para>
+       <para>
+         If the <see cref="P:Jedi.System.CommandLineArgumentAttribute.Prefixes(System.Int32)" /> and/or
+         <see cref="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparators(System.Int32)" /> lists are empty, a
+         <see cref="F:System.String.Empty" /> value will be assumed for the empty list(s). It is thus possible to match
+         on the <see cref="P:Jedi.System.CommandLineArgumentAttribute.Names(System.Int32)" /> list only, without any
+         prefix or value separator specified (though both could be included in the names registered.
+       </para>
+     </remarks>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.Name">
      <summary>
+       Registers a new match name.
      </summary>
      <value>
+       A <see cref="T:System.String" /> registering a new name (setting the property) or retrieving the last registered
+       name (getting the property).
      </value>
+     <remarks>
+       Use this property when decorating a property or method with this attribute to specify the name for which the
+       property or method matches. You can specify this property several times in one decoration to register multiple
+       match names at once.
+     </remarks>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.NameCount">
      <summary>
+       Holds the number of names registered.
      </summary>
      <value>
+       An <see cref="T:System.Int32" /> indicating the number of names that are registered to match.
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.Names(System.Int32)">
      <summary>
+       The list of names registered.
      </summary>
      <param name="index">
+       The 0-based index in the list.
      </param>
      <value>
+       The name registered to match.
      </value>
+     <seealso cref="P:Jedi.System.CommandLineArgumentAttribute.Name" />
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.Prefix">
      <summary>
+     	Registers a new match prefix.
      </summary>
      <value>
+       A <see cref="T:System.String" /> registering a new prefix (setting the property) or retrieving the last registered
+       prefix (getting the property).
      </value>
+     <remarks>
+       Use this property when decorating a property or method with this attribute to specify the prefixes to combine with
+       every registered name as a command line argument match. You can specify this property several times in one
+       decoration to register multiple match prefixes at once, but each prefix will be used for any registered names,
+       including any name registered before the next prefix is registered.
+     </remarks>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.PrefixCount">
      <summary>
+       Holds the number of prefixes registered.
      </summary>
      <value>
+       An <see cref="T:System.Int32" /> indicating the number of prefixes that are registered to match with each
+       registered name.
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.Prefixes(System.Int32)">
      <summary>
+       The list of prefixes registered.
      </summary>
      <param name="index">
+       The 0-based index in the list.
      </param>
      <value>
+       The prefix registered to match with every registered name.
      </value>
+     <seealso cref="P:Jedi.System.CommandLineArgumentAttribute.Prefix" />
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparator">
      <summary>
+     	Registers a new name/value separator.
      </summary>
      <value>
+       A <see cref="T:System.String" /> registering a new name/value separator (setting the property) or retrieving the
+       last registered separator (getting the property).
      </value>
+     <remarks>
+       Use this property when decorating a property or method with this attribute to specify the separator between the
+       name and value to combine with every registered name as a command line argument match. You can specify this
+       property several times in one decoration to register multiple separators at once, but each separator will be used
+       for any registered names, including any name registered before the next separator is registered.
+     </remarks>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparatorCount">
      <summary>
+       Holds the number of name/value separators registered.
      </summary>
      <value>
+       An <see cref="T:System.Int32" /> indicating the number of name/value separators that are registered to match with
+       each registered name.
      </value>
    </member>
    <member name="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparators(System.Int32)">
      <summary>
+       The list of name/value separators registered.
      </summary>
      <param name="index">
+       The 0-based index in the list.
      </param>
      <value>
+       The name/value separator registered to match with every registered name.
      </value>
+     <seealso cref="P:Jedi.System.CommandLineArgumentAttribute.ValueSeparator" />
    </member>
    <member name="T:Jedi.System.CommandLineException">
      <summary>
+       The exception that is thrown when either a parsing error occurs or an error is detected in the use of the
+       <see cref="T:Jedi.System.CommandLineArgumentAttribute" />.
      </summary>
    </member>
    <member name="M:Jedi.System.CommandLineException.#ctor">
!     <exclude />
    </member>
    <member name="M:Jedi.System.CommandLineException.#ctor(System.String)">
!     <exclude />
    </member>
    <member name="M:Jedi.System.CommandLineException.#ctor(System.String,System.Exception)">
!     <exclude />
    </member>
  </members>
\ No newline at end of file