Skip to content

Commit

Permalink
made documentation updates by converting java-doc type comments to .n…
Browse files Browse the repository at this point in the history
…et style comments.
  • Loading branch information
jvilalta committed Feb 9, 2011
1 parent 68afe61 commit cb630ef
Show file tree
Hide file tree
Showing 22 changed files with 102 additions and 119 deletions.
2 changes: 1 addition & 1 deletion src/Quartz/CalendarIntervalScheduleBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
namespace Quartz
{
/// <summary>
/// <code>CalendarIntervalScheduleBuilder</code> is a {@link ScheduleBuilder}
/// <code>CalendarIntervalScheduleBuilder</code> is a <see cref="IScheduleBuilder" />
/// that defines calendar time (day, week, month, year) interval-based
/// schedules for <code>Trigger</code>s.
/// </summary>
Expand Down
14 changes: 7 additions & 7 deletions src/Quartz/Core/QuartzScheduler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1008,7 +1008,7 @@ public virtual void TriggerJob(JobKey jobKey, JobDataMap data)
}

/// <summary>
/// Store and schedule the identified <code>{@link org.quartz.spi.OperableTrigger}</code>
/// Store and schedule the identified <see cref="IOperableTrigger"/>
/// </summary>
/// <param name="trig"></param>
public void TriggerJob(IOperableTrigger trig)
Expand Down Expand Up @@ -1326,7 +1326,7 @@ public virtual ITrigger GetTrigger(TriggerKey triggerKey)
}

/// <summary>
/// Determine whether a {@link Job} with the given identifier already
/// Determine whether a <see cref="IJob"/> with the given identifier already
/// exists within the scheduler.
/// </summary>
/// <remarks>
Expand All @@ -1341,7 +1341,7 @@ public bool CheckExists(JobKey jobKey)
}

/// <summary>
/// Determine whether a {@link Trigger} with the given identifier already
/// Determine whether a <see cref="ITrigger" /> with the given identifier already
/// exists within the scheduler.
/// </summary>
/// <remarks>
Expand All @@ -1356,8 +1356,8 @@ public bool CheckExists(TriggerKey triggerKey)
}

/// <summary>
/// Clears (deletes!) all scheduling data - all {@link Job}s, {@link Trigger}s
/// {@link Calendar}s.
/// Clears (deletes!) all scheduling data - all <see cref="IJob"/>s, <see cref="ITrigger" />s
/// <see cref="ICalendar" />s.
/// </summary>
public void Clear()
{
Expand Down Expand Up @@ -1454,7 +1454,7 @@ public bool RemoveInternalJobListener(string name)
}

/// <summary>
/// Get a List containing all of the <code>{@link org.quartz.JobListener}</code>s
/// Get a List containing all of the <see cref="IJobListener" />s
/// in the <code>Scheduler</code>'s <i>internal</i> list.
/// </summary>
/// <returns></returns>
Expand Down Expand Up @@ -1533,7 +1533,7 @@ public IList<ITriggerListener> InternalTriggerListeners
}

/// <summary>
/// Get the <i>internal</i> <code>{@link TriggerListener}</code> that
/// Get the <i>internal</i> <see cref="ITriggerListener" /> that
/// has the given name.
/// </summary>
/// <param name="name"></param>
Expand Down
2 changes: 1 addition & 1 deletion src/Quartz/CronScheduleBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ namespace Quartz
{

/// <summary>
/// <code>CronScheduleBuilder</code> is a {@link ScheduleBuilder} that defines
/// <code>CronScheduleBuilder</code> is a <see cref="IScheduleBuilder" /> that defines
/// {@link CronExpression}-based schedules for <code>Trigger</code>s.
/// </summary>
/// <remarks>
Expand Down
32 changes: 16 additions & 16 deletions src/Quartz/IListenerManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ namespace Quartz
{
/// <summary>
/// Client programs may be interested in the 'listener' interfaces that are
/// available from Quartz. The <code>{@link JobListener}</code> interface
/// available from Quartz. The <see cref="IJobListener" /> interface
/// provides notifications of <code>Job</code> executions. The
/// <code>{@link TriggerListener}</code> interface provides notifications of
/// <code>Trigger</code> firings. The <code>{@link SchedulerListener}</code>
/// <see cref="ITriggerListener" /> interface provides notifications of
/// <code>Trigger</code> firings. The <see cref="ISchedulerListener" />
/// interface provides notifications of <code>Scheduler</code> events and
/// errors. Listeners can be associated with local schedulers through the
/// {@link ListenerManager} interface.
Expand All @@ -42,7 +42,7 @@ namespace Quartz
public interface IListenerManager
{
/// <summary>
/// Add the given <code>{@link JobListener}</code> to the <code>Scheduler</code>,
/// Add the given <see cref="IJobListener" /> to the <code>Scheduler</code>,
/// and register it to receive events for Jobs that are matched by ANY of the
/// given Matchers.
/// </summary>
Expand All @@ -54,7 +54,7 @@ public interface IListenerManager
void AddJobListener(IJobListener jobListener, params IMatcher<JobKey>[] matchers);

/// <summary>
/// Add the given <code>{@link JobListener}</code> to the <code>Scheduler</code>,
/// Add the given <see cref="IJobListener" /> to the <code>Scheduler</code>,
/// and register it to receive events for Jobs that are matched by ANY of the
/// given Matchers.
/// </summary>
Expand Down Expand Up @@ -110,26 +110,26 @@ public interface IListenerManager
IList<IMatcher<JobKey>> GetJobListenerMatchers(string listenerName);

/// <summary>
/// Remove the identified <code>{@link JobListener}</code> from the <code>Scheduler</code>.
/// Remove the identified <see cref="IJobListener" /> from the <code>Scheduler</code>.
/// </summary>
/// <remarks>
/// </remarks>
/// <returns>true if the identified listener was found in the list, and removed.</returns>
bool RemoveJobListener(string name);

/// <summary>
/// Get a List containing all of the <code>{@link JobListener}</code>s in
/// Get a List containing all of the <see cref="IJobListener" />s in
/// the <code>Scheduler</code>.
/// </summary>
IList<IJobListener> GetJobListeners();

/// <summary>
/// Get the <code>{@link JobListener}</code> that has the given name.
/// Get the <see cref="IJobListener" /> that has the given name.
/// </summary>
IJobListener GetJobListener(string name);

/// <summary>
/// Add the given <code>{@link TriggerListener}</code> to the <code>Scheduler</code>,
/// Add the given <see cref="ITriggerListener" /> to the <code>Scheduler</code>,
/// and register it to receive events for Triggers that are matched by ANY of the
/// given Matchers.
/// </summary>
Expand All @@ -141,7 +141,7 @@ public interface IListenerManager
void AddTriggerListener(ITriggerListener triggerListener, params IMatcher<TriggerKey>[] matchers);

/// <summary>
/// Add the given <code>{@link TriggerListener}</code> to the <code>Scheduler</code>,
/// Add the given <see cref="ITriggerListener" /> to the <code>Scheduler</code>,
/// and register it to receive events for Triggers that are matched by ANY of the
/// given Matchers.
/// </summary>
Expand Down Expand Up @@ -197,7 +197,7 @@ public interface IListenerManager
IList<IMatcher<TriggerKey>> GetTriggerListenerMatchers(string listenerName);

/// <summary>
/// Remove the identified <code>{@link TriggerListener}</code> from the <code>Scheduler</code>.
/// Remove the identified <see cref="ITriggerListener" /> from the <code>Scheduler</code>.
/// </summary>
/// <remarks>
/// </remarks>
Expand All @@ -206,24 +206,24 @@ public interface IListenerManager
bool RemoveTriggerListener(string name);

/// <summary>
/// Get a List containing all of the <code>{@link TriggerListener}</code>s
/// Get a List containing all of the <see cref="ITriggerListener" />s
/// in the <code>Scheduler</code>.
/// </summary>
IList<ITriggerListener> GetTriggerListeners();

/// <summary>
/// Get the <code>{@link TriggerListener}</code> that has the given name.
/// Get the <see cref="ITriggerListener" /> that has the given name.
/// </summary>
ITriggerListener GetTriggerListener(string name);

/// <summary>
/// Register the given <code>{@link SchedulerListener}</code> with the
/// Register the given <see cref="ISchedulerListener" /> with the
/// <code>Scheduler</code>.
/// </summary>
void AddSchedulerListener(ISchedulerListener schedulerListener);

/// <summary>
/// Remove the given <code>{@link SchedulerListener}</code> from the
/// Remove the given <see cref="ISchedulerListener" /> from the
/// <code>Scheduler</code>.
/// </summary>
/// <remarks>
Expand All @@ -232,7 +232,7 @@ public interface IListenerManager
bool RemoveSchedulerListener(ISchedulerListener schedulerListener);

/// <summary>
/// Get a List containing all of the <code>{@link SchedulerListener}</code>s
/// Get a List containing all of the <see cref="ISchedulerListener" />s
/// registered with the <code>Scheduler</code>.
/// </summary>
IList<ISchedulerListener> GetSchedulerListeners();
Expand Down
2 changes: 1 addition & 1 deletion src/Quartz/IScheduler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ public interface IScheduler
bool UnscheduleJob(TriggerKey triggerKey);

/// <summary>
/// Remove all of the indicated <code>{@link Trigger}</code>s from the scheduler.
/// Remove all of the indicated <code><see cref="ITrigger" /></code>s from the scheduler.
/// </summary>
/// <remarks>
/// <p>If the related job does not have any other triggers, and the job is
Expand Down
2 changes: 1 addition & 1 deletion src/Quartz/ISchedulerListener.cs
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public interface ISchedulerListener


/// <summary>
/// Called by the <code>{@link Scheduler}</code> to inform the listener
/// Called by the <see cref="IScheduler" /> to inform the listener
/// that all jobs, triggers and calendars were deleted.
/// </summary>
void SchedulingDataCleared();
Expand Down
4 changes: 2 additions & 2 deletions src/Quartz/Impl/AdoJobStore/IDriverDelegate.cs
Original file line number Diff line number Diff line change
Expand Up @@ -743,8 +743,8 @@ int UpdateTriggerStateFromOtherStates(ConnectionAndTransactionHolder conn, Trigg


/// <summary>
/// Clear (delete!) all scheduling data - all {@link Job}s, {@link Trigger}s
/// {@link Calendar}s.
/// Clear (delete!) all scheduling data - all <see cref="IJob"/>s, <see cref="ITrigger" />s
/// <see cref="ICalendar" />s.
/// </summary>
/// <param name="conn"></param>
void ClearData(ConnectionAndTransactionHolder conn);
Expand Down
8 changes: 4 additions & 4 deletions src/Quartz/Impl/AdoJobStore/JobStoreSupport.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1667,7 +1667,7 @@ protected virtual Collection.ISet<JobKey> GetJobNames(ConnectionAndTransactionHo
}

/// <summary>
/// Determine whether a {@link Job} with the given identifier already
/// Determine whether a <see cref="IJob"/> with the given identifier already
/// exists within the scheduler.
/// </summary>
/// <remarks>
Expand All @@ -1693,7 +1693,7 @@ protected bool CheckExists(ConnectionAndTransactionHolder conn, JobKey jobKey)
}

/// <summary>
/// Determine whether a {@link Trigger} with the given identifier already
/// Determine whether a <see cref="ITrigger" /> with the given identifier already
/// exists within the scheduler.
/// </summary>
/// <remarks>
Expand All @@ -1719,8 +1719,8 @@ protected bool CheckExists(ConnectionAndTransactionHolder conn, TriggerKey trigg
}

/// <summary>
/// Clear (delete!) all scheduling data - all {@link Job}s, {@link Trigger}s
/// {@link Calendar}s.
/// Clear (delete!) all scheduling data - all <see cref="IJob"/>s, <see cref="ITrigger" />s
/// <see cref="ICalendar" />s.
/// </summary>
/// <remarks>
/// </remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ namespace Quartz.Impl.AdoJobStore
/// A base implementation of {@link TriggerPersistenceDelegate} that persists
/// trigger fields in the "QRTZ_SIMPROP_TRIGGERS" table. This allows extending
/// concrete classes to simply implement a couple methods that do the work of
/// getting/setting the trigger's fields, and creating the {@link ScheduleBuilder}
/// getting/setting the trigger's fields, and creating the <see cref="IScheduleBuilder" />
/// for the particular type of trigger.
/// </summary>
/// <remarks>
Expand Down
4 changes: 2 additions & 2 deletions src/Quartz/Impl/AdoJobStore/StdAdoDelegate.cs
Original file line number Diff line number Diff line change
Expand Up @@ -489,8 +489,8 @@ public virtual int DeleteFiredTriggers(ConnectionAndTransactionHolder conn, stri


/// <summary>
/// Clear (delete!) all scheduling data - all {@link Job}s, {@link Trigger}s
/// {@link Calendar}s.
/// Clear (delete!) all scheduling data - all <see cref="IJob"/>s, <see cref="ITrigger" />s
/// <see cref="ICalendar" />s.
/// </summary>
/// <remarks>
/// </remarks>
Expand Down
2 changes: 1 addition & 1 deletion src/Quartz/Impl/Triggers/CalendarIntervalTriggerImpl.cs
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,7 @@ public override void Validate()
}

/// <summary>
/// Get a {@link ScheduleBuilder} that is configured to produce a
/// Get a <see cref="IScheduleBuilder" /> that is configured to produce a
/// schedule identical to this trigger's schedule.
/// </summary>
/// <remarks>
Expand Down
66 changes: 29 additions & 37 deletions src/Quartz/Job/DirectoryScanJob.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,37 @@

namespace Quartz.Job
{
/**
* Inspects a directory and compares whether any files' "last modified dates"
* have changed since the last time it was inspected. If one or more files
* have been updated (or created), the job invokes a "call-back" method on an
* identified <code>DirectoryScanListener</code> that can be found in the
* <code>SchedulerContext</code>.
*
* @author pl47ypus
* @author jhouse
* @see org.quartz.jobs.DirectoryScanListener
* @see org.quartz.SchedulerContext
*/

///<summary>
/// Inspects a directory and compares whether any files' "last modified dates"
/// have changed since the last time it was inspected. If one or more files
/// have been updated (or created), the job invokes a "call-back" method on an
/// identified <see cref="IDirectoryScanListener"/> that can be found in the
/// <see cref="SchedulerContext"/>.
/// </summary>
/// <author>pl47ypus</author>
/// <author>James House</author>
/// <author>Marko Lahma (.NET)</author>
///
[DisallowConcurrentExecution]
[PersistJobDataAfterExecution]
public class DirectoryScanJob : IJob
{
/**
* <code>JobDataMap</code> key with which to specify the directory to be
* monitored - an absolute path is recommended.
*/
///<see cref="JobDataMap"/> key with which to specify the directory to be
/// monitored - an absolute path is recommended.
public const string DIRECTORY_NAME = "DIRECTORY_NAME";

/**
* <code>JobDataMap</code> key with which to specify the
* {@link org.quartz.jobs.DirectoryScanListener} to be
* notified when the directory contents change.
*/
/// <see cref="JobDataMap"/> key with which to specify the
/// <see cref="IDirectoryScanListener"/> to be
/// notified when the directory contents change.
public const string DIRECTORY_SCAN_LISTENER_NAME = "DIRECTORY_SCAN_LISTENER_NAME";

/**
* <code>JobDataMap</code> key with which to specify a <code>long</code>
* value that represents the minimum number of milliseconds that must have
* past since the file's last modified time in order to consider the file
* new/altered. This is necessary because another process may still be
* in the middle of writing to the file when the scan occurs, and the
* file may therefore not yet be ready for processing.
*
* <p>If this parameter is not specified, a default value of
* <code>5000</code> (five seconds) will be used.</p>
*/
/// <see cref="JobDataMap"/> key with which to specify a <see cref="long"/>
/// value that represents the minimum number of milliseconds that must have
/// passed since the file's last modified time in order to consider the file
/// new/altered. This is necessary because another process may still be
/// in the middle of writing to the file when the scan occurs, and the
/// file may therefore not yet be ready for processing.
/// <p>If this parameter is not specified, a default value of <pre>5000</pre> (five seconds) will be used.</p>
public const string MINIMUM_UPDATE_AGE = "MINIMUM_UPDATE_AGE";

private const string LAST_MODIFIED_TIME = "LAST_MODIFIED_TIME";
Expand All @@ -58,10 +48,12 @@ public DirectoryScanJob()
log = LogManager.GetLogger(GetType());
}

/**
* @see org.quartz.Job#execute(org.quartz.JobExecutionContext)
*/

/// <summary>
/// This is the main entry point for job execution. The scheduler will call this method on the
/// job once it is triggered.
/// </summary>
/// <param name="context">The <see cref="IJobExecutionContext"/> that
/// the job will use during execution.</param>
public void Execute(IJobExecutionContext context)
{
JobDataMap mergedJobDataMap = context.MergedJobDataMap;
Expand Down
Loading

0 comments on commit cb630ef

Please sign in to comment.