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

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

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

Added Files:
	Jedi.Timers.Schedules.xml 
Log Message:
Partially done with the Schedules documentation

--- NEW FILE: Jedi.Timers.Schedules.xml ---
<snippets>
  <!-- interval parameter snippet
       arg0 = unit interval in plural form  (eg. days, weeks or months)
  -->
  <ParamInterval>
    <param name="interval">
      The interval in {0} between selected dates.
    </param>
  </ParamInterval>
  <!-- schedules parameter snippet
  -->
  <ParamSchedules>
    <param name="schedules">
      The schedules to add as children.
    </param>
  </ParamSchedules>
  <!-- start parameter snippet
       arg0 = unit interval in plural form  (eg. days, weeks or months)
  -->
  <ParamStart>
    <param name="start">
      The start offset in {0} from the start of the parent schedule's current selection. Specify 0 (zero) to start
      immediately at the start of the parent schedule's current selection (ie. no starting limitation).
    </param>
  </ParamStart>
  <!-- stop parameter snippet
       arg0 = unit interval in plural form  (eg. days, weeks or months)
  -->
  <ParamStop>
    <param name="stop">
      The end offset in {0} from the <b>start</b> of the parent schedule's current selection. Specify 0 (zero) to end
      where the parent schedule's current selection ends (ie. no ending limitation). If this value is less than
      <paramref name="start" /> but greater than zero, it will assume the schedule will be a one-shot, and thus ends
      the moment it starts.
    </param>
  </ParamStop>
  <!-- Schedule common members snippet
       arg0 = class name (only the part before the Schedule suffix, so Day, Week, Month, etc)
       arg1 = interval unit (eg. day, week or month)
       arg2 = interval unit in plural form (eg. days, weeks or months)
       arg3 = bit size of integer parameters (either 32 or 64)
  -->
  <ScheduleCommonMembers>
    <member name="M:Jedi.Timers.{0}Schedule.#ctor">
      <overloads>
        <ctor />
      </overloads>
      <summary>
        <ctor />
      </summary>
    </member>
    <member name="M:Jedi.Timers.{0}Schedule.#ctor(Jedi.Timers.Schedule[])">
      <summary>
        <ctor>specifying a list of child schedules</ctor>
      </summary>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamSchedules/*' />
    </member>
    <member name="M:Jedi.Timers.{0}Schedule.#ctor(System.Int{3})">
      <summary>
        <ctor>specifying an interval in {2}</ctor>
      </summary>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamInterval/*' arg0="{2}"/>
    </member>
    <member name="M:Jedi.Timers.{0}Schedule.#ctor(System.Int{3},Jedi.Timers.Schedule[])">
      <summary>
        <ctor>specifying an interval in {2} and a list of child schedules</ctor>
      </summary>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamInterval/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamSchedules/*' />
    </member>
    <member name="M:Jedi.Timers.{0}Schedule.#ctor(System.Int{3},System.Int{3})">
      <summary>
        <ctor>specifying a start and end offset in {2}</ctor>
      </summary>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamStart/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamStop/*' arg0="{2}"/>
    </member>
    <member name="M:Jedi.Timers.{0}Schedule.#ctor(System.Int{3},System.Int{3},Jedi.Timers.Schedule[])">
      <summary>
        <ctor>specifying a start and end offset in {2} and a list of child schedules</ctor>
      </summary>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamStart/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamStop/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamSchedules/*' />
    </member>
    <member name="M:Jedi.Timers.{0}Schedule.#ctor(System.Int{3},System.Int{3},System.Int{3})">
      <summary>
        <ctor>specifying an interval, a start and end offset (all in {2})</ctor>
      </summary>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamInterval/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamStart/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamStop/*' arg0="{2}"/>
    </member>
    <member name="M:Jedi.Timers.{0}Schedule.#ctor(System.Int{3},System.Int{3},System.Int{3},Jedi.Timers.Schedule[])">
      <summary>
        <ctor>specifying an interval, a start and end offset (all in {2}) and a list of child schedules</ctor>
      </summary>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamInterval/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamStart/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamStop/*' arg0="{2}"/>
      <include file='Jedi.Timers.Schedules.xml' path='/snippets/ParamSchedules/*' />
    </member>
  </ScheduleCommonMembers>
</snippets>