From 64ea9978a82c1821b3903b28e99bae8d45b2159d Mon Sep 17 00:00:00 2001 From: mob41 Date: Mon, 2 May 2016 13:06:52 +0800 Subject: [PATCH] Update Javadoc --- src/main/java/com/mob41/kmbeta/api/ArrivalManager.java | 6 ++++-- src/main/java/com/mob41/kmbeta/api/KmbApi.java | 1 + 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/main/java/com/mob41/kmbeta/api/ArrivalManager.java b/src/main/java/com/mob41/kmbeta/api/ArrivalManager.java index 6da497b..b768055 100644 --- a/src/main/java/com/mob41/kmbeta/api/ArrivalManager.java +++ b/src/main/java/com/mob41/kmbeta/api/ArrivalManager.java @@ -102,6 +102,7 @@ public class ArrivalManager { * @param busno Bus No. * @param stop_code Bus Stop Code (e.g. WO04N12500), probably it is specified from a BUS DB source. * @param bound Bus Direction/Bound (1 or 2) + * @param language Language to be selected ArrivalManager.ENGLISH_LANG or ArrivalManager.CHINESE_LANG * @throws InvalidArrivalTargetException If the specified target arrival was invalid * @throws CouldNotLoadDatabaseException If the API could not load the database */ @@ -213,7 +214,7 @@ public ArrivalTime getArrivalTime(){ *
* Different cases to return another string:
* ---: If srvhr, srvmin, arrhr, arrmin is -1
- * Arrived: If remainMin <= 0 + * Arrived: If remainMin smaller or equal to 0 * @return A String with the format mentioned above */ public String getArrivalTimeRemaining_Formatted(){ @@ -309,7 +310,6 @@ public String getArrivalTime_Formatted() throws NoETADataFetchedError, NoServerT * Get all the buses of this ArrivalManager's bus stop
*
* Returns a list with nothing if no buses match the bus-stop code - * @param stopcode The Bus-Stop code * @return List */ public List getBusStopBuses(){ @@ -398,6 +398,7 @@ public static boolean generateDatabase(){ * It is automatically called if the database in the memory is null.
* Must be called before any database reading events. * @param fromClassResources Load from Class-path
+ * @param parent A class parent to be specified * If true, make sure the bus_stopdb.properties is attached in the class-path.
* If false, make sure the bus_stopdb.properties is inside the working directory. * @return Boolean whether the database is successfully loaded. @@ -476,6 +477,7 @@ private static int getBusNoIndex(String bus_no){ *
* Returns -1 if the route or the bus-stop code do not exist. * @param route The Bus-Stop Number/Name + * @param boundno The Bound of the route * @param stopcode The Bus-Stop code * @return Integer */ diff --git a/src/main/java/com/mob41/kmbeta/api/KmbApi.java b/src/main/java/com/mob41/kmbeta/api/KmbApi.java index cac750a..307560d 100644 --- a/src/main/java/com/mob41/kmbeta/api/KmbApi.java +++ b/src/main/java/com/mob41/kmbeta/api/KmbApi.java @@ -582,6 +582,7 @@ public static String[] getFormattedTableData(int bus_index, int stop_index){ *
* Returns -1 if the route or the bus-stop code do not exist. * @param route The Bus-Stop Number/Name + * @param boundno The bound of the route * @param stopcode The Bus-Stop code * @return Integer */