[JEDI.NET-commits] docs/snippets Jedi.System.CommandLine.xml,NONE,1.1 Jedi.Timers.Schedules.xml,1.2,1.3

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

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

Modified Files:
	Jedi.Timers.Schedules.xml 
Added Files:
	Jedi.System.CommandLine.xml 
Log Message:
Various updates and additions to the documentation

--- NEW FILE: Jedi.System.CommandLine.xml ---
<snippets>
  <!-- ListProperties
       arg0=fully qualified class name
       arg1=base property name
       arg2=the entity the list represents
       arg3=as above but in plural form
       arg4=what the base property is used for (used in remarks section of base property only).
       arg5=additional remarks for base property
  -->
  <ListProperties>
    <member name="P:{0}.{1}">
    <summary>
      Registers a new {2}.
    </summary>
    <value>
      A <see cref="T:System.String" /> registering a new {2} (setting the property) or retrieving the last
      registered {2} (getting the property).
    </value>
    <remarks>
      Use this property when decorating a property or method with this attribute to specify {4}. You can
      specify this property several times in one decoration to register multiple {3} at once{5}.
    </remarks>
    </member>
    <member name="P:{0}.{1}Count">
    <summary>
      Holds the number of {3} registered.
    </summary>
    <value>
      An <see cref="T:System.Int32" /> indicating the number of {3} that are registered.
    </value>
    </member>
    <member name="P:{0}.{1}s(System.Int32)">
      <summary>
        The list of {3} registered.
      </summary>
      <param name="index">
        The 0-based index in the list.
      </param>
      <value>
        The {2} registered.
      </value>
      <seealso cref="P:{0}.{1}" />
    </member>
  </ListProperties>
  <!-- ArgClassCtor
       arg0=class prefix
  -->
  <ArgClassCtor>
    <member name="M:Jedi.System.CommandLine.{0}Argument.#ctor(System.String,System.Boolean,System.Object,System.Reflection.MemberInfo)">
      <summary>
        <ctor />
      </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">
        <option>The instance to which the property or method for this switch belongs</option>
        <option><see langword="null" /> if the property or method is <see langword="static" />.</option>
      </param>
      <param name="memberInfo">
        The method or property this switch is linked to.
      </param>
    </member>
  </ArgClassCtor>
</snippets>
Index: Jedi.Timers.Schedules.xml
===================================================================
RCS file: /cvsroot/jedidotnet/docs/snippets/Jedi.Timers.Schedules.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Jedi.Timers.Schedules.xml	25 Jun 2005 13:17:03 -0000	1.2
--- Jedi.Timers.Schedules.xml	11 Jul 2005 18:57:54 -0000	1.3
***************
*** 50,53 ****
--- 50,81 ----
      </member>
    </PropInterval>
+   <!-- Start property snippet
+        arg0 = class name (only the part before the Schedule suffix, so Day, Week, Month, etc)
+        arg1 = interval unit in plural form
+   -->
+   <PropStart>
+     <member name="P:Jedi.Timers.{0}Schedule.Start">
+       <summary>
+         The schedule's start offset in {1} from the parent schedule's current selection.
+       </summary>
+       <value>
+         The schedule's start offset in {1} from the parent schedule's current selection.
+       </value>
+     </member>
+   </PropStart>
+   <!-- Stop property snippet
+        arg0 = class name (only the part before the Schedule suffix, so Day, Week, Month, etc)
+        arg1 = interval unit in plural form
+   -->
+   <PropStop>
+     <member name="P:Jedi.Timers.{0}Schedule.Stop">
+       <summary>
+         The schedule's end offset in {1} from the parent schedule's current selection.
+       </summary>
+       <value>
+         The schedule's end offset in {1} from the parent schedule's current selection.
+       </value>
+     </member>
+   </PropStop>
    <!-- Schedule common members snippet
         arg0 = class name (only the part before the Schedule suffix, so Day, Week, Month, etc)