Add documentation to TimerCallback

2014-02-25 01:21:26 +01:00
parent a95ab27d5e
commit f8460d5030
1 changed files with 6 additions and 0 deletions
@@ -1,5 +1,11 @@
 package com.garbagemule.MobArena.util.timer;

+/**
+ * The TimerCallback interface provides hooks for various events in the
+ * timer framework. When given a valid callback instance, the timers will
+ * call its methods when it starts, stops, finishes and ticks, when
+ * applicable.
+ */
 public interface TimerCallback {
    /**
     * Called when the timer is started.