Commits

Zemian Deng committed 39b5a9b

Updated javadoc.

Comments (0)

Files changed (1)

timemachine-scheduler/src/main/java/timemachine/scheduler/Scheduler.java

 
 /**
  * A scheduler interface is the main entry point into the scheduler system. It provides methods to manage {@link JobDef}
- * and {@link Schedule}, and controls the scheduler life- cycles. There is only one implementation,
- * {@link SchedulerEngine} provided by TimeMachine scheduler, and you usually do not instantiate it manually. Instead you
+ * and {@link Schedule}, and control the scheduler life-cycles. There is only one implementation,
+ * {@link SchedulerEngine} that's provided by TimeMachine, and you usually do not instantiate it manually. Instead you
  * would use the {@link SchedulerFactory} to create one. A {@link SchedulerEngine} is simply a container of many
  * {@link Service}'s. You can use a config properties file to control and set any services that best fit your scheduling
  * need.
  * <p>
- * Here is an example on how to get a default instance of a scheduler and to schedule a JobDef with a Schedule: 
+ * Here is an example on how to get a default instance of a scheduler, and to schedule a JobDef with a Schedule: 
  * <pre><code>
  * Scheduler scheduler = new SchedulerFactory().createScheduler();
  * try {
  *	jobDef.setJobTaskClass(LoggerJobTask.class);
  *	jobDef.addSchedule(Schedules.secondly(15));
  *	scheduler.schedule(jobDef);
+ *  scheduler.start();
  * } finally {
  * 	scheduler.destroy();
  * }