Added some missing @param and @throws Javadoc comments.

Signed-off-by: Jeffrey Han <itdelatrisu@gmail.com>
This commit is contained in:
Jeffrey Han
2015-09-09 23:51:16 -04:00
parent 831c297ece
commit 6506967c12
19 changed files with 49 additions and 21 deletions

View File

@@ -728,6 +728,7 @@ public class BeatmapParser {
/**
* Returns the file extension of a file.
* @param file the file name
*/
public static String getExtension(String file) {
int i = file.lastIndexOf('.');

View File

@@ -47,7 +47,7 @@ public class BeatmapSet implements Iterable<Beatmap> {
/**
* Returns the beatmap at the given index.
* @param index the beatmap index
* @throws IndexOutOfBoundsException
* @throws IndexOutOfBoundsException if the index is out of range
*/
public Beatmap get(int index) { return beatmaps.get(index); }
@@ -55,7 +55,7 @@ public class BeatmapSet implements Iterable<Beatmap> {
* Removes the beatmap at the given index.
* @param index the beatmap index
* @return the removed beatmap
* @throws IndexOutOfBoundsException
* @throws IndexOutOfBoundsException if the index is out of range
*/
public Beatmap remove(int index) { return beatmaps.remove(index); }
@@ -72,7 +72,7 @@ public class BeatmapSet implements Iterable<Beatmap> {
* <li>4: CS:{} HP:{} AR:{} OD:{} Stars:{}
* </ul>
* @param index the beatmap index
* @throws IndexOutOfBoundsException
* @throws IndexOutOfBoundsException if the index is out of range
*/
public String[] getInfo(int index) {
Beatmap beatmap = beatmaps.get(index);

View File

@@ -330,6 +330,7 @@ public class BeatmapSetList {
/**
* Expands the node at an index by inserting a new node for each Beatmap
* in that node and hiding the group node.
* @param index the node index
* @return the first of the newly-inserted nodes
*/
public BeatmapSetNode expand(int index) {

View File

@@ -129,7 +129,11 @@ public class BeatmapWatchService {
/** Watch service listener interface. */
public interface BeatmapWatchServiceListener {
/** Indication that an event was received. */
/**
* Indication that an event was received.
* @param kind the event kind
* @param child the child directory
*/
public void eventReceived(WatchEvent.Kind<?> kind, Path child);
}