[JEDI.NET-commits] docs Jedi.Timers.Schedules.xml,1.1,1.2
Status: Pre-Alpha
Brought to you by:
jedi_mbe
Menu
▾
▴
[JEDI.NET-commits] docs Jedi.Timers.Schedules.xml,1.1,1.2
|
From: Marcel B. <jed...@us...> - 2005-06-25 13:17:13
|
Update of /cvsroot/jedidotnet/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6651/docs Modified Files: Jedi.Timers.Schedules.xml Log Message: Updated Jedi.Timers.Schedules documentation Index: Jedi.Timers.Schedules.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.Timers.Schedules.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** Jedi.Timers.Schedules.xml 23 Jun 2005 18:43:32 -0000 1.1 --- Jedi.Timers.Schedules.xml 25 Jun 2005 13:17:03 -0000 1.2 *************** *** 2,15 **** <!--Timestamp most recent auto generation: 2005-06-19 06:13:14 UTC--> <members> - <member name="T:Jedi.Timers.DaySchedule"> - <summary> - Schedule to select single days within an optional parent schedule. - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Day" arg1="day" arg2="days" ! arg3="64" /> <member name="M:Jedi.Timers.DaySchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)"> <exclude /> --- 2,12 ---- <!--Timestamp most recent auto generation: 2005-06-19 06:13:14 UTC--> <members> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Day" arg1="day" arg2="days" ! arg3="64"> ! <replace source="{class_remarks" /> ! </include> <member name="M:Jedi.Timers.DaySchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)"> <exclude /> *************** *** 20,37 **** <member name="T:Jedi.Timers.FixedIntervalSchedule"> <summary> </summary> </member> <member name="M:Jedi.Timers.FixedIntervalSchedule.#ctor(System.Int64,System.Int64,System.Int64,Jedi.Timers.Schedule[],Jedi.Timers.FixedIntervalSchedule.ParamInTicks)"> <summary> </summary> <param name="start"> </param> <param name="stop"> </param> <param name="span"> </param> ! <param name="schedules"> ! </param> <param name="paramsInTicks"> </param> </member> --- 17,49 ---- <member name="T:Jedi.Timers.FixedIntervalSchedule"> <summary> + The base class for schedules with a fixed interval. </summary> + <remarks> + This class functions as the base class for any schedule having a fixed interval; that is, intervals that will + always result in the same increment. This is the case for nearly all schedule classes presented in this namespace, + except for the month and year schedules (incrementing with 1 month would result in an increment of 28, 29, 30 or + 31 days, depending on the month and year). + </remarks> </member> <member name="M:Jedi.Timers.FixedIntervalSchedule.#ctor(System.Int64,System.Int64,System.Int64,Jedi.Timers.Schedule[],Jedi.Timers.FixedIntervalSchedule.ParamInTicks)"> <summary> + <ctor /> </summary> <param name="start"> + The start offset of the schedule, relative to the start of the optional parent schedule. This value can be either + in ticks or in schedule units. The <paramref name="paramsInTicks" /> parameter indicates which. </param> <param name="stop"> + The end offset of the schedule, relative to the start of the optional parent schedule. This value can be either + in ticks or in schedule units. The <paramref name="paramsInTicks" /> parameter indicates which. </param> <param name="span"> + The interval between selected dates. This value can be either in ticks or in schedule units. The + <paramref name="paramsInTicks" /> parameter indicates which. </param> ! <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ParamSchedules/*' /> <param name="paramsInTicks"> + Indicates which of the <paramref name="start" />, <paramref name="stop" /> and <paramref name="span" /> + parameters are specified in ticks (100 nanosecond intervals). </param> </member> *************** *** 54,67 **** <member name="M:Jedi.Timers.FixedIntervalSchedule.InternalUnitInterval"> <summary> </summary> <returns> </returns> </member> ! <member name="P:Jedi.Timers.FixedIntervalSchedule.Interval"> ! <summary> ! </summary> ! <value> ! </value> ! </member> <member name="T:Jedi.Timers.FixedIntervalSchedule.ParamInTicks"> <summary> --- 66,86 ---- <member name="M:Jedi.Timers.FixedIntervalSchedule.InternalUnitInterval"> <summary> + Determines the interval in ticks (100 nanosecond intervals) for this schedule class. </summary> <returns> + An <see cref="T:System.Int64" /> indicating the 100 nanosecond interval for this schedule class. </returns> + <remarks> + The return value of this method specifies the time span used when the schedule selects a range for its child + schedules. It also serves as the multiplier for the constructor's start, stop and span parameters when they are + not specified in ticks. + </remarks> </member> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropInterval/*' ! arg0="FixedInterval"> ! <replace source="{1}"><see cref="M:Jedi.Timers.FixedIntervalSchedule.InternalUnitInterval" /> increments</replace> ! </include> <member name="T:Jedi.Timers.FixedIntervalSchedule.ParamInTicks"> <summary> *************** *** 125,179 **** </value> </member> - <member name="T:Jedi.Timers.HourSchedule"> - <summary> - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Hour" arg1="hour" arg2="hours" ! arg3="64" /> <member name="M:Jedi.Timers.HourSchedule.InternalUnitInterval"> <exclude /> </member> - <member name="T:Jedi.Timers.MillisecondSchedule"> - <summary> - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Millisecond" arg1="millisecond" arg2="milliseconds" ! arg3="64" /> <member name="M:Jedi.Timers.MillisecondSchedule.InternalUnitInterval"> <exclude /> </member> - <member name="T:Jedi.Timers.MinuteSchedule"> - <summary> - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Minute" arg1="minute" arg2="minutes" ! arg3="64" /> <member name="M:Jedi.Timers.MinuteSchedule.InternalUnitInterval"> <exclude /> </member> - <member name="T:Jedi.Timers.MonthSchedule"> - <summary> - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Month" arg1="month" arg2="months" ! arg3="32" /> <member name="M:Jedi.Timers.MonthSchedule.FromMonths(System.Int32)"> <summary> </summary> <param name="months"> </param> <returns> </returns> </member> --- 144,194 ---- </value> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Hour" arg1="hour" arg2="hours" ! arg3="64"> ! <replace source="{class_remarks}" /> ! </include> <member name="M:Jedi.Timers.HourSchedule.InternalUnitInterval"> <exclude /> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Millisecond" arg1="millisecond" arg2="milliseconds" ! arg3="64"> ! <replace source="{class_remarks}" /> ! </include> <member name="M:Jedi.Timers.MillisecondSchedule.InternalUnitInterval"> <exclude /> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Minute" arg1="minute" arg2="minutes" ! arg3="64"> ! <replace source="{class_remarks}" /> ! </include> <member name="M:Jedi.Timers.MinuteSchedule.InternalUnitInterval"> <exclude /> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Month" arg1="month" arg2="months" ! arg3="32"> ! <replace source="{class_remarks}" /> ! </include> <member name="M:Jedi.Timers.MonthSchedule.FromMonths(System.Int32)"> <summary> + Converts a month number to a <see cref="T:System.DateTime" /> value. </summary> <param name="months"> + The month number to convert. </param> <returns> + A <see cref="T:System.DateTime" /> representing the first day of the month an year specified by the + <paramref name="months" /> parameter. </returns> </member> *************** *** 184,193 **** <exclude /> </member> ! <member name="P:Jedi.Timers.MonthSchedule.Interval"> ! <summary> ! </summary> ! <value> ! </value> ! </member> <member name="F:Jedi.Timers.MonthSchedule.MaxMonth"> <summary> --- 199,207 ---- <exclude /> </member> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropInterval/*' ! arg0="Month" ! arg1="months" /> <member name="F:Jedi.Timers.MonthSchedule.MaxMonth"> <summary> *************** *** 294,302 **** <member name="T:Jedi.Timers.Schedule.Enumerator"> <summary> </summary> </member> <member name="M:Jedi.Timers.Schedule.Enumerator.#ctor(Jedi.Timers.Schedule,System.DateTime,System.Boolean)"> <summary> ! Initializes a new instance of the <see-class /> class. </summary> <param name="owner"> --- 308,317 ---- <member name="T:Jedi.Timers.Schedule.Enumerator"> <summary> + The enumerator used to enumerate the selected dates of a schedule. </summary> </member> <member name="M:Jedi.Timers.Schedule.Enumerator.#ctor(Jedi.Timers.Schedule,System.DateTime,System.Boolean)"> <summary> ! <ctor /> </summary> <param name="owner"> *************** *** 325,329 **** </summary> <value> ! A reference to a <see cref="T:jedi.Timers.Schedule" /> derivative that is the owner of the enumerator. </value> </member> --- 340,344 ---- </summary> <value> ! A reference to a <see cref="T:Jedi.Timers.Schedule" /> derivative that is the owner of the enumerator. </value> </member> *************** *** 370,375 **** </summary> <param name="from"> </param> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator"]/returns' /> </member> <member name="M:Jedi.Timers.Schedule.GetEnumerator(System.DateTime,System.Boolean)"> --- 385,393 ---- </summary> <param name="from"> + The date from which to start enumerating. </param> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator"]/returns' /> </member> <member name="M:Jedi.Timers.Schedule.GetEnumerator(System.DateTime,System.Boolean)"> *************** *** 378,384 **** entire schedule hierarchy, starting at a specific date/time. </summary> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator(System.DateTime)"]/param[@name="from"]' /> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator(System.Boolean)"]/param[@name="recursive"]' /> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator"]/returns' /> </member> <member name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"> --- 396,408 ---- entire schedule hierarchy, starting at a specific date/time. </summary> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator(System.DateTime)"]/param[@name="from"]' /> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator(System.Boolean)"]/param[@name="recursive"]' /> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator"]/returns' /> </member> <member name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"> *************** *** 406,410 **** <para> <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the date does not lie within ! the schedule's defined range. </para> </param> --- 430,434 ---- <para> <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the date does not lie within ! the schedule's, or one of its parent schedules', defined range. </para> </param> *************** *** 414,420 **** Determines the selection range for child schedules, considering this schedule only. </summary> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="date"]' /> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="start"]' /> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="stop"]' /> <remarks> <para> --- 438,450 ---- Determines the selection range for child schedules, considering this schedule only. </summary> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="date"]' /> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="start"]' /> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="stop"]' /> <remarks> <para> *************** *** 441,446 **** </param> <param name="recursive"> ! Flag to indicate whether child schedules are to be considered (<see langword="true" />) or not ! (<see langword="false" />) </param> <returns> --- 471,475 ---- </param> <param name="recursive"> ! <true-if>child schedules are to be considered</true-if> </param> <returns> *************** *** 448,453 **** <para>-or-</para> <para> ! <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if no more dates follow the one ! specified by the <paramref name="from" /> parameter. </para> </returns> --- 477,482 ---- <para>-or-</para> <para> ! <fieldref type="System.DateTime" name="MaxValue" reftype="1" /> if no more dates follow the one specified by the ! <paramref name="from" /> parameter. </para> </returns> *************** *** 462,479 **** </param> <param name="offset"> ! <para>The starting date of the parent schedule</para> ! <para>-or-</para> ! <para> ! <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MinValue" /> if the schedule doesn't have a ! parent schedule. ! </para> </param> <param name="maxDate"> ! <para>The end date of the parent schedule</para> ! <para>-or-</para> ! <para> ! <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the schedule doesn't have a ! parent schedule. ! </para> <para> Implementers are not required to adjust the return value if it happens to be greater than this parameter. --- 491,504 ---- </param> <param name="offset"> ! <option>The starting date of the parent schedule</option> ! <option> ! <fieldref type="System.DateTime" name="MinValue" reftype="1" /> if the schedule doesn't have a parent schedule. ! </option> </param> <param name="maxDate"> ! <option>The end date of the parent schedule</option> ! <option> ! <fieldref type="System.DateTime" name="MaxValue" reftype="1" /> if the schedule doesn't have a parent schedule. ! </option> <para> Implementers are not required to adjust the return value if it happens to be greater than this parameter. *************** *** 481,490 **** </param> <returns> ! <para>A <see cref="T:System.DateTime" /> representing the next date of this schedule</para> ! <para>-or-</para> ! <para> ! <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the schedule doesn't have a ! next date. ! </para> </returns> <remarks> --- 506,513 ---- </param> <returns> ! <option>A <typeref type="System.DateTime" /> representing the next date of this schedule</option> ! <option> ! <fieldref type="System.DateTime" name="MaxValue" reftype="1" /> if the schedule doesn't have a next date. ! </option> </returns> <remarks> *************** *** 496,501 **** <para> Normally, the date returned by this method should be the same as the one returned in the start parameter of the ! <see cref="M:Jedi.Timers.Schedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)" /> ! method. </para> </remarks> --- 519,523 ---- <para> Normally, the date returned by this method should be the same as the one returned in the start parameter of the ! <methodref name="GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)" /> method. </para> </remarks> *************** *** 510,515 **** </param> <returns> ! <see langword="true" /> if the date specified by the <paramref name="date" /> parameter is valid for this ! schedule; <see langword="false" /> otherwise. </returns> </member> --- 532,536 ---- </param> <returns> ! <true-if>the date specified by the <paramref name="date" /> parameter is valid for this schedule</true-if>. </returns> </member> *************** *** 520,525 **** <remarks> <para> ! This method will increment the <see cref="F:Jedi.Timers.Schedules.Schedule.FVersion" /> field and ! call the <see cref="M:Jedi.Timers.Schedules.Schedule.OnChanged" /> method. </para> <para> --- 541,546 ---- <remarks> <para> ! This method will increment the <fieldref name="FVersion" /> field and call the <methodref name="OnChanged" /> ! method. </para> <para> *************** *** 531,535 **** <member name="M:Jedi.Timers.Schedule.OnChanged"> <summary> ! Raises the <see cref="E:Jedi.Timers.Schedule.Changed" /> event. </summary> </member> --- 552,556 ---- <member name="M:Jedi.Timers.Schedule.OnChanged"> <summary> ! Raises the <eventref name="Changed" /> event. </summary> </member> *************** *** 539,545 **** </summary> <value> ! <para>The <see cref="T:Jedi.Timers.Schedule" /> (or derivative) that is the owner of this schedule</para> ! <para>-or-</para> ! <para><see langword="null" /> if this schedule is at the root of the hierarchy.</para> </value> </member> --- 560,565 ---- </summary> <value> ! <option>The <typeref /> (or derivative) that is the owner of this schedule</option> ! <option><see langword="null" /> if this schedule is at the root of the hierarchy.</option> </value> </member> *************** *** 665,701 **** <exclude /> </member> - <member name="T:Jedi.Timers.SecondSchedule"> - <summary> - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Second" arg1="second" arg2="seconds" ! arg3="64" /> <member name="M:Jedi.Timers.SecondSchedule.InternalUnitInterval"> <exclude /> </member> - <member name="T:Jedi.Timers.TickSchedule"> - <summary> - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Tick" arg1="tick (100 nanoseconds)" arg2="ticks (multiples of 100 nanoseconds)" ! arg3="64" /> <member name="M:Jedi.Timers.TickSchedule.InternalUnitInterval"> <exclude /> </member> - <member name="T:Jedi.Timers.WeekSchedule"> - <summary> - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Week" arg1="week" arg2="weeks" ! arg3="64" /> <member name="P:Jedi.Timers.WeekSchedule.FirstDayOfWeek"> <summary> --- 685,715 ---- <exclude /> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Second" arg1="second" arg2="seconds" ! arg3="64"> ! <replace source="{class_remarks}" /> ! </include> <member name="M:Jedi.Timers.SecondSchedule.InternalUnitInterval"> <exclude /> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Tick" arg1="tick (100 nanoseconds)" arg2="ticks (multiples of 100 nanoseconds)" ! arg3="64"> ! <replace source="{class_remarks}" /> ! </include> <member name="M:Jedi.Timers.TickSchedule.InternalUnitInterval"> <exclude /> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Week" arg1="week" arg2="weeks" ! arg3="64"> ! <replace source="{class_remarks}" /> ! </include> <member name="P:Jedi.Timers.WeekSchedule.FirstDayOfWeek"> <summary> *************** *** 738,750 **** </summary> </member> - <member name="T:Jedi.Timers.YearSchedule"> - <summary> - </summary> - </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Year" arg1="year" arg2="years" ! arg3="32" /> <member name="M:Jedi.Timers.YearSchedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)"> <exclude /> --- 752,762 ---- </summary> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' arg0="Year" arg1="year" arg2="years" ! arg3="32"> ! <replace source="{class_remarks}" /> ! </include> <member name="M:Jedi.Timers.YearSchedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)"> <exclude /> *************** *** 753,762 **** <exclude /> </member> ! <member name="P:Jedi.Timers.YearSchedule.Interval"> ! <summary> ! </summary> ! <value> ! </value> ! </member> <member name="M:Jedi.Timers.YearSchedule.ScheduleLimit"> <exclude /> --- 765,773 ---- <exclude /> </member> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropInterval/*' ! arg0="Month" ! arg1="months" /> <member name="M:Jedi.Timers.YearSchedule.ScheduleLimit"> <exclude /> |
