[JEDI.NET-commits] docs Jedi.IO.IniFiles.xml,1.9,1.10 Jedi.System.CommandLine.xml,1.7,1.8 Jedi.Timer
Status: Pre-Alpha
Brought to you by:
jedi_mbe
Menu
▾
▴
[JEDI.NET-commits] docs Jedi.IO.IniFiles.xml,1.9,1.10 Jedi.System.CommandLine.xml,1.7,1.8 Jedi.Timers.EventScheduler.xml,1.1,1.2 Jedi.Timers.Schedules.xml,1.2,1.3 namespaceDoc.Jedi.Timers.xml,1.1,1.2
|
From: Marcel B. <jed...@us...> - 2005-07-11 18:58:03
|
Update of /cvsroot/jedidotnet/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18693/docs Modified Files: Jedi.IO.IniFiles.xml Jedi.System.CommandLine.xml Jedi.Timers.EventScheduler.xml Jedi.Timers.Schedules.xml namespaceDoc.Jedi.Timers.xml Log Message: Various updates and additions to the documentation Index: Jedi.IO.IniFiles.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.IO.IniFiles.xml,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -d -r1.9 -r1.10 *** Jedi.IO.IniFiles.xml 14 Mar 2005 12:45:19 -0000 1.9 --- Jedi.IO.IniFiles.xml 11 Jul 2005 18:57:53 -0000 1.10 *************** *** 1,4 **** <?xml version="1.0" encoding="utf-8"?> ! <!--Timestamp most recent auto generation: 2005-03-08 10:12:42 UTC--> <members> <member name="T:Jedi.IO.BufferedIniFile"> --- 1,4 ---- <?xml version="1.0" encoding="utf-8"?> ! <!--Timestamp most recent auto generation: 2005-06-16 14:30:23 UTC--> <members> <member name="T:Jedi.IO.BufferedIniFile"> *************** *** 53,62 **** <exclude /> </member> ! <member name="M:Jedi.IO.BufferedIniFile.AutoFlushHandler(Jedi.Timers.ScheduledEvent)"> <summary> The event handler called to check if changes should be written to disk. </summary> <param name="event"> ! The <see cref="T:Jedi.Timers.ScheduledEvent" /> instance that raised the event. </param> </member> --- 53,62 ---- <exclude /> </member> ! <member name="M:Jedi.IO.BufferedIniFile.AutoFlushHandler(Jedi.Timers.ScheduledEventBase)"> <summary> The event handler called to check if changes should be written to disk. </summary> <param name="event"> ! The <see cref="T:Jedi.Timers.ScheduledEventBase" /> instance that raised the event. </param> </member> *************** *** 77,85 **** </value> </member> ! <member name="M:Jedi.IO.BufferedIniFile.AutoReloadHandler(Jedi.Timers.ScheduledEvent)"> <summary> The event handler called to check if outside changes should be merged from disk. </summary> ! <include file='Jedi.IO.IniFiles.xml' path='/members/member[@name="M:Jedi.IO.BufferedIniFile.AutoFlushHandler(Jedi.Timers.ScheduledEvent)"]/param[@name="event"]' /> </member> <member name="P:Jedi.IO.BufferedIniFile.AutoReloadInterval"> --- 77,85 ---- </value> </member> ! <member name="M:Jedi.IO.BufferedIniFile.AutoReloadHandler(Jedi.Timers.ScheduledEventBase)"> <summary> The event handler called to check if outside changes should be merged from disk. </summary> ! <include file='Jedi.IO.IniFiles.xml' path='/members/member[@name="M:Jedi.IO.BufferedIniFile.AutoFlushHandler(Jedi.Timers.ScheduledEventBase)"]/param[@name="event"]' /> </member> <member name="P:Jedi.IO.BufferedIniFile.AutoReloadInterval"> *************** *** 737,740 **** --- 737,742 ---- <member name="T:Jedi.IO.IniFileBase.IniFileEnumerator"> <summary> + Implements the <see cref="T:Jedi.IO.IniFileBase.IIniFileEnumerator" /> interface to provide + enumeration over the IniFile contents. </summary> </member> Index: Jedi.Timers.EventScheduler.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.Timers.EventScheduler.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** Jedi.Timers.EventScheduler.xml 2 Mar 2005 16:59:37 -0000 1.1 --- Jedi.Timers.EventScheduler.xml 11 Jul 2005 18:57:54 -0000 1.2 *************** *** 1,140 **** <?xml version="1.0" encoding="utf-8"?> ! <!--Timestamp most recent auto generation: 2005-03-02 15:57:57 UTC--> <members> <member name="T:Jedi.Timers.ScheduledEvent"> <summary> </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEvent.#ctor(System.Int64,Jedi.Timers.ScheduledEventCallback)"> <summary> </summary> ! <param name="interval"> </param> <param name="callback"> </param> </member> ! <member name="P:Jedi.Timers.ScheduledEvent.Interval"> <summary> </summary> <value> </value> </member> ! <member name="M:Jedi.Timers.ScheduledEvent.RunAndReschedule(System.Object)"> <summary> </summary> ! <param name="state"> </param> </member> ! <member name="P:Jedi.Timers.ScheduledEvent.ScheduledFor"> <summary> </summary> - <value> - </value> </member> ! <member name="T:Jedi.Timers.ScheduledEventCallback"> <summary> </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEventCallback.#ctor(System.Object,System.IntPtr)"> <summary> </summary> - <param name="object"> - </param> - <param name="method"> - </param> </member> ! <member name="M:Jedi.Timers.ScheduledEventCallback.BeginInvoke(Jedi.Timers.ScheduledEvent,System.AsyncCallback,System.Object)"> <summary> </summary> - <param name="event"> - </param> - <param name="callback"> - </param> - <param name="object"> - </param> <returns> </returns> </member> ! <member name="M:Jedi.Timers.ScheduledEventCallback.EndInvoke(System.IAsyncResult)"> <summary> </summary> - <param name="result"> - </param> </member> ! <member name="M:Jedi.Timers.ScheduledEventCallback.Invoke(Jedi.Timers.ScheduledEvent)"> <summary> </summary> - <param name="event"> - </param> </member> ! <member name="T:Jedi.Timers.ScheduledEvents"> <summary> </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEvents.#ctor"> <summary> </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEvents.AddEvent(Jedi.Timers.ScheduledEvent)"> <summary> </summary> ! <param name="event"> </param> </member> ! <member name="M:Jedi.Timers.ScheduledEvents.CompareTimes"> <summary> </summary> ! <returns> ! </returns> </member> ! <member name="M:Jedi.Timers.ScheduledEvents.EventsWaiting"> <summary> </summary> ! <returns> ! </returns> </member> ! <member name="P:Jedi.Timers.ScheduledEvents.EventTriggerChecks"> <summary> </summary> ! <value> ! </value> </member> ! <member name="F:Jedi.Timers.ScheduledEvents.FEventTriggerChecks"> <summary> </summary> </member> <member name="F:Jedi.Timers.ScheduledEvents.FHasStarted"> ! <summary> ! </summary> </member> <member name="F:Jedi.Timers.ScheduledEvents.FHasStopped"> ! <summary> ! </summary> </member> <member name="F:Jedi.Timers.ScheduledEvents.FQueueCount"> ! <summary> ! </summary> </member> <member name="F:Jedi.Timers.ScheduledEvents.FWaitEndedCount"> ! <summary> ! </summary> </member> <member name="P:Jedi.Timers.ScheduledEvents.HasStarted"> ! <summary> ! </summary> ! <value> ! </value> </member> <member name="P:Jedi.Timers.ScheduledEvents.HasStopped"> ! <summary> ! </summary> ! <value> ! </value> </member> <member name="M:Jedi.Timers.ScheduledEvents.NotificationsWaiting"> ! <summary> ! </summary> ! <returns> ! </returns> </member> <member name="M:Jedi.Timers.ScheduledEvents.ProcessNotifications"> --- 1,201 ---- <?xml version="1.0" encoding="utf-8"?> ! <!--Timestamp most recent auto generation: 2005-06-19 06:13:15 UTC--> <members> <member name="T:Jedi.Timers.ScheduledEvent"> <summary> + Represents a scheduled event or callback, using the <see cref="T:Jedi.Timers.Schedule" />. </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEvent.#ctor(Jedi.Timers.Schedule,Jedi.Timers.ScheduledEventCallback)"> <summary> + <ctor /> </summary> ! <param name="schedule"> ! <include file='Jedi.Timers.EventScheduler.xml' ! path='/members/member[@name="P:Jedi.Timers.ScheduledEvent.Schedule"]/summary/*' /> </param> <param name="callback"> + The event or callback to invoke at the specified dates and times. </param> + <exception cref="T:System.ArgumentNullException"> + <condition>The <paramref name="schedule" /> parameter is <see langword="null" /></condition> + <condition>The <paramref name="callback" /> parameter is <see langword="null" />.</condition> + </exception> </member> ! <member name="M:Jedi.Timers.ScheduledEvent.NextEvent"> ! <exclude /> ! </member> ! <member name="P:Jedi.Timers.ScheduledEvent.Schedule"> <summary> + The schedule defining the dates and times at which the event or callback should be invoked. </summary> <value> + <include file='Jedi.Timers.EventScheduler.xml' + path='/members/member[@name="P:Jedi.Timers.ScheduledEvent.Schedule"]/summary/*' /> </value> </member> ! <member name="M:Jedi.Timers.ScheduledEvent.ScheduleChanged(System.Object,System.EventArgs)"> <summary> + Reschedules the event or callback when the defining schedule has changed. </summary> ! <param name="sender"> ! The defining schedule that has changed. ! </param> ! <param name="e"> ! An <see cref="T:System.EventArgs" /> instance. </param> </member> ! <member name="T:Jedi.Timers.ScheduledEventBase"> <summary> + Represents a scheduled event or callback. </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEventBase.#ctor(Jedi.Timers.ScheduledEventCallback)"> <summary> + <ctor /> </summary> + <include file='Jedi.Timers.EventScheduler.xml' + path='/members/member[@name="M:Jedi.Timers.ScheduledEvent.#ctor(Jedi.Timers.Schedule,Jedi.Timers.ScheduledEventCallback)"]/param[@name="callback"]' /> </member> ! <member name="M:Jedi.Timers.ScheduledEventBase.AddSchedule"> <summary> + Adds the event or callback to the list of scheduled calls. </summary> </member> ! <member name="E:Jedi.Timers.ScheduledEventBase.Callback"> <summary> + <include file='Jedi.Timers.EventScheduler.xml' + path='/members/member[@name="M:Jedi.Timers.ScheduledEvent.#ctor(Jedi.Timers.Schedule,Jedi.Timers.ScheduledEventCallback)"]/param[@name="callback"]/*' /> + </summary> + </member> + <member name="M:Jedi.Timers.ScheduledEventBase.NextEvent"> + <summary> + Determines the date and time at which the scheduled event should be invoked next. </summary> <returns> + <case> + <fieldref type="System.DateTime" name="MaxValue" reftype="1" /> if the event is not scheduled to be invoked from + the current date. + </case> + <case> + A <see cref="T:System.DateTime" /> representing the date and time at which the scheduled event should be invoked + from the current date. + </case> </returns> </member> ! <member name="M:Jedi.Timers.ScheduledEventBase.OnCallback"> <summary> + Raises the <eventref name="Callback" /> event. </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEventBase.RemoveSchedule"> <summary> + Removes the event or callback from the list of scheduled calls. </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEventBase.Reschedule"> <summary> + Reschedules the event or callback, re-adding it to the list of scheduled calls. </summary> </member> ! <member name="M:Jedi.Timers.ScheduledEventBase.ReScheduleFor(System.Int64)"> <summary> </summary> + <param name="time"> + </param> </member> ! <member name="M:Jedi.Timers.ScheduledEventBase.RunAndReschedule(System.Object)"> <summary> + Invokes the event or callback and reschedules it. </summary> ! <param name="state"> ! The timer state. </param> </member> ! <member name="P:Jedi.Timers.ScheduledEventBase.ScheduledFor"> <summary> + Indicates the date and time at which the event is scheduled to be invoked. </summary> ! <value> ! An <see cref="T:System.Int64" /> indicating the date and time, in ticks, at which the event is scheduled to be ! invoked. ! </value> </member> ! <member name="T:Jedi.Timers.ScheduledEventCallback"> <summary> + Represents the method that will be scheduled. </summary> ! <param name="event"> ! The scheduled event that invoked the callback. ! </param> </member> ! <member name="M:Jedi.Timers.ScheduledEventCallback.#ctor(System.Object,System.IntPtr)"> ! <exclude /> ! </member> ! <member name="M:Jedi.Timers.ScheduledEventCallback.BeginInvoke(Jedi.Timers.ScheduledEventBase,System.AsyncCallback,System.Object)"> ! <exclude /> ! </member> ! <member name="M:Jedi.Timers.ScheduledEventCallback.EndInvoke(System.IAsyncResult)"> ! <exclude /> ! </member> ! <member name="M:Jedi.Timers.ScheduledEventCallback.Invoke(Jedi.Timers.ScheduledEventBase)"> ! <exclude /> ! </member> ! <member name="T:Jedi.Timers.ScheduledEvents"> ! <threadsafety static="true" instance="true" /> <summary> + An event scheduler. </summary> ! <remarks> ! <para> ! With this <see langword="static" /> class, you can have any number of events called based on any ! schedule. Currently only one type of event scheduling is provided, and that is by using the ! <see cref="T:System.Timers.Schedules" /> class and its derivatives. ! </para> ! </remarks> </member> ! <member name="M:Jedi.Timers.ScheduledEvents.#ctor"> ! <exclude /> ! </member> ! <member name="M:Jedi.Timers.ScheduledEvents.AddEvent(Jedi.Timers.ScheduledEventBase)"> <summary> + Adds a new scheduled event to the list of scheduled events. </summary> + <param name="event"> + The scheduled event to add. + </param> + </member> + <member name="M:Jedi.Timers.ScheduledEvents.CompareTimes"> + <exclude /> + </member> + <member name="M:Jedi.Timers.ScheduledEvents.EventsWaiting"> + <exclude /> + </member> + <member name="P:Jedi.Timers.ScheduledEvents.EventTriggerChecks"> + <exclude /> + </member> + <member name="F:Jedi.Timers.ScheduledEvents.FEventTriggerChecks"> + <exclude /> </member> <member name="F:Jedi.Timers.ScheduledEvents.FHasStarted"> ! <exclude /> </member> <member name="F:Jedi.Timers.ScheduledEvents.FHasStopped"> ! <exclude /> </member> <member name="F:Jedi.Timers.ScheduledEvents.FQueueCount"> ! <exclude /> </member> <member name="F:Jedi.Timers.ScheduledEvents.FWaitEndedCount"> ! <exclude /> </member> <member name="P:Jedi.Timers.ScheduledEvents.HasStarted"> ! <exclude /> </member> <member name="P:Jedi.Timers.ScheduledEvents.HasStopped"> ! <exclude /> </member> <member name="M:Jedi.Timers.ScheduledEvents.NotificationsWaiting"> ! <exclude /> </member> <member name="M:Jedi.Timers.ScheduledEvents.ProcessNotifications"> *************** *** 143,166 **** </member> <member name="P:Jedi.Timers.ScheduledEvents.QueueCount"> ! <summary> ! </summary> ! <value> ! </value> </member> ! <member name="M:Jedi.Timers.ScheduledEvents.RemoveEvent(Jedi.Timers.ScheduledEvent)"> <summary> </summary> <param name="event"> </param> </member> <member name="M:Jedi.Timers.ScheduledEvents.TimerLoop"> <summary> </summary> </member> <member name="P:Jedi.Timers.ScheduledEvents.WaitEndedCount"> ! <summary> ! </summary> ! <value> ! </value> </member> </members> \ No newline at end of file --- 204,224 ---- </member> <member name="P:Jedi.Timers.ScheduledEvents.QueueCount"> ! <exclude /> </member> ! <member name="M:Jedi.Timers.ScheduledEvents.RemoveEvent(Jedi.Timers.ScheduledEventBase)"> <summary> + Removes a scheduled event from the list of scheduled events. </summary> <param name="event"> + The scheduled event to remove. </param> </member> <member name="M:Jedi.Timers.ScheduledEvents.TimerLoop"> <summary> + Polling thread execution loop. </summary> </member> <member name="P:Jedi.Timers.ScheduledEvents.WaitEndedCount"> ! <exclude /> </member> </members> \ No newline at end of file Index: Jedi.Timers.Schedules.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/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 *************** *** 7,11 **** arg2="days" arg3="64"> ! <replace source="{class_remarks" /> </include> <member name="M:Jedi.Timers.DaySchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)"> --- 7,11 ---- arg2="days" arg3="64"> ! <replace source="{class_remarks}" /> </include> <member name="M:Jedi.Timers.DaySchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)"> *************** *** 49,60 **** </member> <member name="M:Jedi.Timers.FixedIntervalSchedule.CalculateOffset(System.Int64,System.Boolean)"> ! <summary> ! </summary> ! <param name="parentStart"> ! </param> ! <param name="isLimit"> ! </param> ! <returns> ! </returns> </member> <member name="M:Jedi.Timers.FixedIntervalSchedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)"> --- 49,53 ---- </member> <member name="M:Jedi.Timers.FixedIntervalSchedule.CalculateOffset(System.Int64,System.Boolean)"> ! <exclude /> </member> <member name="M:Jedi.Timers.FixedIntervalSchedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)"> *************** *** 81,112 **** 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> </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.All"> <summary> </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Interval"> <summary> </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Limits"> <summary> </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.None"> <summary> </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Start"> <summary> </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Stop"> <summary> </summary> </member> --- 74,116 ---- path='snippets/PropInterval/*' arg0="FixedInterval"> ! <replace source="{1}"><methodref name="InternalUnitInterval" /> increments</replace> </include> <member name="T:Jedi.Timers.FixedIntervalSchedule.ParamInTicks"> <summary> + The type used to specify which parameters of the + <methodref name="#ctor(System.Int64,System.Int64,System.Int64,Jedi.Timers.Schedule[],Jedi.Timers.FixedIntervalSchedule.ParamInTicks)" /> + constructor are specified in ticks (100 nanosecond intervals). </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.All"> <summary> + The <paramref name="interval" />, <paramref name="start" /> and <paramref name="stop" /> parameters are specified + in ticks (100 nanosecond intervals). </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Interval"> <summary> + The <paramref name="interval" /> parameter is specified in ticks (100 nanosecond intervals). </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Limits"> <summary> + The <paramref name="start" /> and <paramref name="stop" /> parameters are specified in ticks (100 nanosecond + intervals). </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.None"> <summary> + None of the parameters are specified in ticks (100 nanosecond intervals). </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Start"> <summary> + The <paramref name="start" /> parameter is specified in ticks (100 nanosecond intervals). </summary> </member> <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Stop"> <summary> + The <paramref name="stop" /> parameter is specified in ticks (100 nanosecond intervals). </summary> </member> *************** *** 116,145 **** <member name="P:Jedi.Timers.FixedIntervalSchedule.Span"> <summary> </summary> <value> </value> </member> ! <member name="P:Jedi.Timers.FixedIntervalSchedule.Start"> ! <summary> ! </summary> ! <value> ! </value> ! </member> <member name="P:Jedi.Timers.FixedIntervalSchedule.StartDT"> <summary> </summary> <value> </value> </member> ! <member name="P:Jedi.Timers.FixedIntervalSchedule.Stop"> ! <summary> ! </summary> ! <value> ! </value> ! </member> <member name="P:Jedi.Timers.FixedIntervalSchedule.StopDT"> <summary> </summary> <value> </value> </member> --- 120,159 ---- <member name="P:Jedi.Timers.FixedIntervalSchedule.Span"> <summary> + The schedule's selection interval expressed as a <see cref="T:System.TimeSpan" />. </summary> <value> + A <see cref="T:System.TimeSpan" /> representing the schedule's selection interval. </value> </member> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropStart/*' ! arg0="FixedInterval"> ! <replace source="{1}"><methodref name="InternalUnitInterval" /> increments</replace> ! </include> <member name="P:Jedi.Timers.FixedIntervalSchedule.StartDT"> <summary> + The schedule's start offset from the parent schedule's current selection, expressed as a + <see cref="T:System.DateTime" />. </summary> <value> + A <see cref="T:System.DateTime" /> representing the schedule's start offset in {1} from the parent schedule's + current selection. </value> </member> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropStop/*' ! arg0="FixedInterval"> ! <replace source="{1}"><methodref name="InternalUnitInterval" /> increments</replace> ! </include> <member name="P:Jedi.Timers.FixedIntervalSchedule.StopDT"> <summary> + The schedule's end offset from the parent schedule's current selection, expressed as a + <see cref="T:System.DateTime" />. </summary> <value> + A <see cref="T:System.DateTime" /> representing the schedule's end offset in {1} from the parent schedule's + current selection. </value> </member> *************** *** 189,193 **** </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> --- 203,207 ---- </param> <returns> ! A <see cref="T:System.DateTime" /> representing the first day of the month and year specified by the <paramref name="months" /> parameter. </returns> *************** *** 206,209 **** --- 220,224 ---- <member name="F:Jedi.Timers.MonthSchedule.MaxMonth"> <summary> + The maximum number of months you can specify as the start and/or end offset, or the interval. </summary> </member> *************** *** 211,232 **** <exclude /> </member> ! <member name="P:Jedi.Timers.MonthSchedule.Start"> ! <summary> ! </summary> ! <value> ! </value> ! </member> ! <member name="P:Jedi.Timers.MonthSchedule.Stop"> ! <summary> ! </summary> ! <value> ! </value> ! </member> <member name="M:Jedi.Timers.MonthSchedule.ToMonths(System.DateTime)"> <summary> </summary> <param name="date"> </param> <returns> </returns> </member> --- 226,249 ---- <exclude /> </member> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropStart/*' ! arg0="Month" ! arg1="months" /> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropStop/*' ! arg0="Month" ! arg1="months" /> <member name="M:Jedi.Timers.MonthSchedule.ToMonths(System.DateTime)"> <summary> + Converts a <see cref="T:System.DateTime" /> value to a month number. </summary> <param name="date"> + The date to convert. </param> <returns> + A <see cref="T:System.Int32" /> representing the month number for the combination of year and month in the + <paramref name="date" /> parameter. </returns> </member> *************** *** 258,262 **** <member name="M:Jedi.Timers.Schedule.#ctor(Jedi.Timers.Schedule[])"> <summary> ! Initializes a new instance of the <see-class /> class. </summary> <param name="schedules"> --- 275,279 ---- <member name="M:Jedi.Timers.Schedule.#ctor(Jedi.Timers.Schedule[])"> <summary> ! <ctor /> </summary> <param name="schedules"> *************** *** 323,327 **** </param> <param name="recursive"> ! <true-if> the child schedules should be considered when enumerating</true-if> </param> </member> --- 340,344 ---- </param> <param name="recursive"> ! <true-if>the child schedules should be considered when enumerating</true-if> </param> </member> *************** *** 352,357 **** <remarks> This field is used internally by the enumerator to check whether the schedule has changed since the enumerator ! was first created. The value is incremented upon each call to <see cref="M:Jedi.Timers.Schedule.Modified" />, ! which in turn is called automatically when one of the schedule properties are changed. </remarks> </member> --- 369,374 ---- <remarks> This field is used internally by the enumerator to check whether the schedule has changed since the enumerator ! was first created. The value is incremented upon each call to <methodref name="Modified" />, which in turn is ! called automatically when one of the schedule properties are changed. </remarks> </member> *************** *** 377,381 **** the date and times of this schedule should be enumerated. </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)"> --- 394,400 ---- the date and times of this schedule should be enumerated. </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)"> *************** *** 414,435 **** </param> <param name="start"> ! <para> ! Upon return, a <see cref="T:System.DateTime" /> indicating the start of this schedules selection range ! </para> ! <para>-or-</para> ! <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> <param name="stop"> ! <para> ! Upon return, a <see cref="T:System.DateTime" /> indicating the end of this schedules selection range ! </para> ! <para>-or-</para> ! <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> </member> --- 433,448 ---- </param> <param name="start"> ! <case>Upon return, a <see cref="T:System.DateTime" /> indicating the start of this schedules selection range</case> ! <case> <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the date does not lie within the schedule's defined range. ! </case> </param> <param name="stop"> ! <case>Upon return, a <see cref="T:System.DateTime" /> indicating the end of this schedules selection range</case> ! <case> <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. ! </case> </param> </member> *************** *** 645,649 **** <para> Wrapping a schedule hierarchy as a single hierarchy is often used when a complex hierarchy is defined to select ! a certain range, but each of selections in that range requires the exact same child selections. </para> <para> --- 658,662 ---- <para> Wrapping a schedule hierarchy as a single hierarchy is often used when a complex hierarchy is defined to select ! a certain range, but each of the selections in that range requires the exact same child selections. </para> <para> *************** *** 665,673 **** Wraps a schedule hierarchy as a single schedule and adds the specified child schedules. </summary> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.Wrap(Jedi.Timers.Schedule)"]/param[@name="scheduleHierarchy"]' /> <param name="schedules"> The schedules to add as children of the wrapped schedule. </param> ! <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.Wrap(Jedi.Timers.Schedule)"]/returns' /> </member> <member name="T:Jedi.Timers.ScheduleException"> --- 678,690 ---- Wraps a schedule hierarchy as a single schedule and adds the specified child schedules. </summary> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.Wrap(Jedi.Timers.Schedule)"]/param[@name="scheduleHierarchy"]' /> <param name="schedules"> The schedules to add as children of the wrapped schedule. </param> ! <include ! file='Jedi.Timers.Schedules.xml' ! path='/members/member[@name="M:Jedi.Timers.Schedule.Wrap(Jedi.Timers.Schedule)"]/returns' /> </member> <member name="T:Jedi.Timers.ScheduleException"> *************** *** 713,726 **** </include> <member name="P:Jedi.Timers.WeekSchedule.FirstDayOfWeek"> ! <summary> ! </summary> ! <value> ! </value> </member> <member name="P:Jedi.Timers.WeekSchedule.FirstPartialWeek"> ! <summary> ! </summary> ! <value> ! </value> </member> <member name="M:Jedi.Timers.WeekSchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)"> --- 730,737 ---- </include> <member name="P:Jedi.Timers.WeekSchedule.FirstDayOfWeek"> ! <exclude /> </member> <member name="P:Jedi.Timers.WeekSchedule.FirstPartialWeek"> ! <exclude /> </member> <member name="M:Jedi.Timers.WeekSchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)"> *************** *** 731,754 **** </member> <member name="P:Jedi.Timers.WeekSchedule.LastPartialWeek"> ! <summary> ! </summary> ! <value> ! </value> </member> <member name="T:Jedi.Timers.WeekSchedule.PartialWeekOption"> ! <summary> ! </summary> </member> <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.Allowed"> ! <summary> ! </summary> </member> <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.ForChildSchedulesOnly"> ! <summary> ! </summary> </member> <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.NotAllowed"> ! <summary> ! </summary> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' --- 742,758 ---- </member> <member name="P:Jedi.Timers.WeekSchedule.LastPartialWeek"> ! <exclude /> </member> <member name="T:Jedi.Timers.WeekSchedule.PartialWeekOption"> ! <exclude /> </member> <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.Allowed"> ! <exclude /> </member> <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.ForChildSchedulesOnly"> ! <exclude /> </member> <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.NotAllowed"> ! <exclude /> </member> <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*' *************** *** 768,787 **** file='snippets\Jedi.Timers.Schedules.xml' path='snippets/PropInterval/*' ! arg0="Month" ! arg1="months" /> <member name="M:Jedi.Timers.YearSchedule.ScheduleLimit"> <exclude /> </member> ! <member name="P:Jedi.Timers.YearSchedule.Start"> ! <summary> ! </summary> ! <value> ! </value> ! </member> ! <member name="P:Jedi.Timers.YearSchedule.Stop"> ! <summary> ! </summary> ! <value> ! </value> ! </member> </members> \ No newline at end of file --- 772,789 ---- file='snippets\Jedi.Timers.Schedules.xml' path='snippets/PropInterval/*' ! arg0="Year" ! arg1="years" /> <member name="M:Jedi.Timers.YearSchedule.ScheduleLimit"> <exclude /> </member> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropStart/*' ! arg0="Month" ! arg1="months" /> ! <include ! file='snippets\Jedi.Timers.Schedules.xml' ! path='snippets/PropStop/*' ! arg0="Month" ! arg1="months" /> </members> \ No newline at end of file Index: namespaceDoc.Jedi.Timers.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/namespaceDoc.Jedi.Timers.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** namespaceDoc.Jedi.Timers.xml 2 Mar 2005 16:59:37 -0000 1.1 --- namespaceDoc.Jedi.Timers.xml 11 Jul 2005 18:57:54 -0000 1.2 *************** *** 4,7 **** --- 4,9 ---- <member name="N:Jedi.Timers"> <summary> + Provides classes that can be used to schedule events/callbacks to be called at certain intervals or according to + complex schedules. </summary> </member> Index: Jedi.System.CommandLine.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.System.CommandLine.xml,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** Jedi.System.CommandLine.xml 12 Mar 2005 18:08:43 -0000 1.7 --- Jedi.System.CommandLine.xml 11 Jul 2005 18:57:54 -0000 1.8 *************** *** 1,5 **** <?xml version="1.0" encoding="utf-8"?> ! <!--Timestamp most recent auto generation: 2005-03-08 10:12:44 UTC--> <members> <member name="T:Jedi.System.CommandLine"> <summary> --- 1,70 ---- <?xml version="1.0" encoding="utf-8"?> ! <!--Timestamp most recent auto generation: 2005-06-16 14:30:23 UTC--> <members> + <member name="T:Jedi.System.BooleanCommandLineArgumentAttribute"> + <summary> + Attribute used to provide information on the command line argument(s) this boolean property refers to. + </summary> + <remarks> + <para> + The attribute can be attached to a property of type <see cref="T:System.Boolean" />. + </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 recognize and link to the + property or method. + </para> + </remarks> + </member> + <member name="M:Jedi.System.BooleanCommandLineArgumentAttribute.#ctor"> + <summary> + <ctor />. + </summary> + </member> + <include + file='snippets\Jedi.System.CommandLine.xml' + path='snippets/ListProperties/*' + arg0="Jedi.System.BooleanCommandLineArgumentAttribute" + arg1="FalseValue" + arg2='<see langword="false" /> command line operand' + arg3='<see langword="false" /> command line operands' + arg4='the argument operands that will result in setting the property to <see langword="false" /> when one of them is specified on the command line' + arg5="" /> + <member name="P:Jedi.System.BooleanCommandLineArgumentAttribute.FalseValueList"> + <summary> + A <see cref="T:System.ArrayList" /> containing all registered <see langword="false" /> command line operands. + </summary> + <value> + A <see cref="T:System.ArrayList" /> containing all registered <see langword="false" /> command line operands. + </value> + </member> + <member name="P:Jedi.System.BooleanCommandLineArgumentAttribute.NoValueAction"> + <summary> + Specifies what action to take when the argument has no operand on the command line. + </summary> + <value> + The value that indicates the action to take when a boolean-type argument on the command line has no operand following it. + </value> + </member> + <include + file='snippets\Jedi.System.CommandLine.xml' + path='snippets/ListProperties/*' + arg0="Jedi.System.BooleanCommandLineArgumentAttribute" + arg1="TrueValue" + arg2='<see langword="true" /> command line operand' + arg3='<see langword="true" /> command line operands' + arg4='the argument operands that will result in setting the property to <see langword="true" /> when one of them is specified on the command line' + arg5="" /> + <member name="P:Jedi.System.BooleanCommandLineArgumentAttribute.TrueValueList"> + <summary> + A <see cref="T:System.ArrayList" /> containing all registered <see langword="true" /> command line operands. + </summary> + <value> + A <see cref="T:System.ArrayList" /> containing all registered <see langword="true" /> command line operands. + </value> + </member> <member name="T:Jedi.System.CommandLine"> <summary> *************** *** 9,17 **** <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. --- 74,83 ---- <member name="M:Jedi.System.CommandLine.#ctor(System.Object[],System.String)"> <summary> ! <ctor />. </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. *************** *** 53,82 **** </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" />. ! </para> ! </param> ! <param name="memberInfo"> ! The method or property this switch is linked to. ! </param> ! </member> <member name="P:Jedi.System.CommandLine.Argument.CaseSensitive"> <summary> --- 119,126 ---- </summary> </member> ! <include ! file='snippets/Jedi.System.CommandLine.xml' ! path='snippets/ArgClassCtor/*' ! arg0="" /> <member name="P:Jedi.System.CommandLine.Argument.CaseSensitive"> <summary> *************** *** 84,89 **** </summary> <value> ! <see langword="true" /> if the value in the <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> property ! should be compared case sensitive; otherwise, <see langword="false" />. </value> </member> --- 128,133 ---- </summary> <value> ! <true-if>the value in the <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> property ! should be compared case sensitive</true-if>. </value> </member> *************** *** 105,109 **** <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 --- 149,153 ---- <term>Less than zero</term> <description> ! <case> <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 *************** *** 111,119 **** (<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 --- 155,160 ---- (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is <see langword="false" />) the case of the two strings will have been ignored. ! </case> ! <case> <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 *************** *** 122,126 **** 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> --- 163,167 ---- case-sensitive (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is <see langword="false" />) the case of the two strings will have been ignored. ! </case> </description> </item> *************** *** 128,141 **** <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 --- 169,179 ---- <term>Zero</term> <description> ! <case> <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. ! </case> ! <case> <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 *************** *** 144,148 **** 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> --- 182,186 ---- case-sensitive (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is <see langword="false" />) the case of the two strings will have been ignored. ! </case> </description> </item> *************** *** 150,154 **** <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 --- 188,192 ---- <term>Greater than zero</term> <description> ! <case> <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 *************** *** 156,164 **** (<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 --- 194,199 ---- (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is <see langword="false" />) the case of the two strings will have been ignored. ! </case> ! <case> <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 *************** *** 167,177 **** 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> --- 202,209 ---- case-sensitive (<see cref="P:Jedi.System.CommandLine.Argument.CaseSensitive" /> is <see langword="false" />) the case of the two strings will have been ignored. ! </case> ! <case> <paramref name="obj" /> is a <see langword="null" />. ! </case> </description> </item> *************** *** 180,184 **** <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. --- 212,216 ---- <remarks> <para> ! <paramref name="obj" /> must be <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. *************** *** 192,197 **** </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> --- 224,229 ---- </remarks> <exception cref="T:System.ArgumentException"> ! <paramref name="obj" /> is not <see langword="null" />, an instance of ! <see cref="T:Jedi.System.CommandLine.Argument" /> or an instance of <see cref="T:System.String" />. </exception> </member> *************** *** 201,213 **** </summary> <value> ! <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" />. ! </para> </value> </member> --- 233,238 ---- </summary> <value> ! <case>The instance to which the property or method for this switch belongs.</case> ! <case><see langword="null" /> if the property or method is <see langword="static" />.</case> </value> </member> *************** *** 227,239 **** </summary> <value> ! <para> A <see cref="T:System.Reflection.PropertyInfo" /> representing the property this switch is linked to. ! </para> ! <para> ! -or- ! </para> ! <para> A <see cref="T:System.Reflection.MethodInfo" /> representing the method this switch is linked to. ! </para> </value> </member> --- 252,261 ---- </summary> <value> ! <case> A <see cref="T:System.Reflection.PropertyInfo" /> representing the property this switch is linked to. ! </case> ! <case> A <see cref="T:System.Reflection.MethodInfo" /> representing the method this switch is linked to. ! </case> </value> </member> *************** *** 257,266 **** This method is called by the <see cref="T:Jedi.System.CommandLine">command line parser</see> when the switch specified by the <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> was found. The method will delegate ! processing to either the linked method or handle set the property to the correct value. </remarks> </member> ! <member name="M:Jedi.System.CommandLine.Argument.ProcessBoolean(System.String,System.String,System.Int32@)"> <summary> ! Processes the argument as a boolean. </summary> <param name="match"> --- 279,293 ---- This method is called by the <see cref="T:Jedi.System.CommandLine">command line parser</see> when the switch specified by the <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> was found. The method will delegate ! processing to either the linked method or the proper handler for the linked property. </remarks> + <exception cref="T:Jedi.System.CommandLineException"> + <condition>No handler was registered for the linked property's type</condition> + <condition>An invalid operand value was found</condition> + <condition>No operand value was found, but one was expected.</condition> + </exception> </member> ! <member name="M:Jedi.System.CommandLine.Argument.ProcessImpl(System.String,System.String,System.Int32@)"> <summary> ! Processes the argument. </summary> <param name="match"> *************** *** 273,277 **** <param name="index"> <para> ! Upon entry, the index where the optional + or - operand should be. </para> <para> --- 300,304 ---- <param name="index"> <para> ! Upon entry, the index where the optional operand should be. </para> <para> *************** *** 282,351 **** <remarks> <para> ! This method is called for a property of the type <see cref="T:System.Boolean" />. It will look for a plus, minus ! or space character. </para> <para> - If a plus (+) character is detected, the linked property will be set to <see langword="true" />. The minus (-) - character will set the property to <see langword="false" />. The space character will toggle the property. </para> <exception cref="T:Jedi.System.CommandLineException"> ! The first character after the switch is invalid (ie. it is not a plus (+), minus (-) or space character). </exception> </remarks> </member> ! <member name="M:Jedi.System.CommandLine.Argument.ProcessInt(System.String,System.String,System.Int32@)"> <summary> ! Processes the argument as an integer type. </summary> ! <param name="match"> ! The match string of the argument as found on the command line. This can differ in case only from the ! <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> property. ! </param> ! <param name="commandLine"> ! The command line being parsed. </param> ! <param name="index"> ! <para> ! Upon entry, the index where the integer operand should be. ! </para> ! <para> ! Upon exit, the index where the next switch or literal can be found (any spaces following this switch are ! skipped). ! </para> </param> - <remarks> - <para> - This method is called for a property of any integer type (<see cref="T:System.Int16" />), - <see cref="T:System.Int32" />), <see cref="T:System.Int64" />)). It will use the property type's Parse - method to parse the operand text as a string. - </para> - <para> - Because it uses the actual Parse method of the integer type of the property, parsing is limited to the format - allowed by the various Parse methods. The Parse method of the type will be called with the - <see cref="F:System.Globalization.NumberFormatInfo.InvariantInfo" /> and - <see cref="F:System.Globalization.CultureInfo.InvariantCulture" /> arguments. - </para> - </remarks> </member> ! <member name="M:Jedi.System.CommandLine.Argument.ProcessString(System.String,System.String,System.Int32@)"> <summary> ! Processes the argument as a string type. </summary> ! <param name="match"> ! The match string of the argument as found on the command line. This can differ in case only from the ! <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> property. ! </param> ! <param name="commandLine"> ! The command line being parsed. ! </param> ! <param name="index"> ! <para> ! Upon entry, the index where the string operand should be. ! </para> ! <para> ! Upon exit, the index where the next switch or literal can be found (any spaces following this switch are ! skipped). ! </para> ! </param> </member> <member name="M:Jedi.System.CommandLine.CheckAndProcessArgument(System.String,System.Int32@)"> --- 309,390 ---- <remarks> <para> ! This method is called when an argument has been found on the command line. Implementers will process an operand ! value on the command line. </para> <para> </para> <exception cref="T:Jedi.System.CommandLineException"> ! <condition>An invalid operand value was found</condition> ! <condition>No operand value was found, but one was expected.</condition> </exception> </remarks> </member> ! <member name="M:Jedi.System.CommandLine.Argument.RegisterHandler(System.Type,System.Type)"> <summary> ! Registers an <see cref="T:Jedi.System.CommandLine.Argument" /> descendant to use for a specific ! <see cref="T:System.Type" />. </summary> ! <param name="valueType"> ! Property type for which to register the argument. </param> ! <param name="argumentType"> ! Argument type that will handle properties of the type specified by the <paramref name="valueType" /> parameter. </param> </member> ! <member name="M:Jedi.System.CommandLine.Argument.TypeHandlers"> <summary> ! A dictionary containing the list of registered property types and their argument processing types. </summary> ! <returns> ! An <see cref="T:System.Collections.IDictionary" />, containing the argument processing types, indexed on property type. ! </returns> ! </member> ! <member name="T:Jedi.System.CommandLine.BooleanArgument"> ! <summary> ! The argument class used for <see cref="T:System.Boolean" /> type properties. ! </summary> ! </member> ! <include ! file='snippets/Jedi.System.CommandLine.xml' ! path='snippets/ArgClassCtor/*' ! arg0="Boolean" /> ! <member name="P:Jedi.System.CommandLine.BooleanArgument.NoValueAction"> ! <include ! file='Jedi.System.CommandLine.xml' ! path='/members/member[@name="P:Jedi.System.BooleanCommandLineArgumentAttribute.NoValueAction"]/*' /> ! </member> ! <member name="T:Jedi.System.CommandLine.BooleanArgument.NoValueActionEnum"> ! <summary> ! The enumeration type used to specify the action to take when a <see cref="T:System.Boolean" /> type argument ! doesn't have an operand on the command line. ! </summary> ! </member> ! <member name="F:Jedi.System.CommandLine.BooleanArgument.NoValueActionEnum.Ignore"> ! <summary> ! Ignore the command line agrument completely. ! </summary> ! </member> ! <member name="F:Jedi.System.CommandLine.BooleanArgument.NoValueActionEnum.Reset"> ! <summary> ! Set the property to <see langword="false" />. ! </summary> ! </member> ! <member name="F:Jedi.System.CommandLine.BooleanArgument.NoValueActionEnum.Set"> ! <summary> ! Set the property to <see langword="true" />. ! </summary> ! </member> ! <member name="F:Jedi.System.CommandLine.BooleanArgument.NoValueActionEnum.ThrowException"> ! <summary> ! Throw a <see cref="T:Jedi.System.CommandLineException" /> exception. ! </summary> ! </member> ! <member name="F:Jedi.System.CommandLine.BooleanArgument.NoValueActionEnum.Toggle"> ! <summary> ! Toggle the property. ! </summary> ! </member> ! <member name="M:Jedi.System.CommandLine.BooleanArgument.ProcessImpl(System.String,System.String,System.Int32@)"> ! <exclude /> </member> <member name="M:Jedi.System.CommandLine.CheckAndProcessArgument(System.String,System.Int32@)"> *************** *** 366,370 **** </param> <returns> ! <see langword="true" /> if the current argument was a registered switch; otherwise, <see... [truncated message content] |
