Skip to content
This repository has been archived by the owner on Dec 4, 2022. It is now read-only.

Commit

Permalink
Update Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
a1aw committed May 2, 2016
1 parent a6dbcf5 commit 64ea997
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/main/java/com/mob41/kmbeta/api/ArrivalManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>ArrivalManager.ENGLISH_LANG</code> or <code>ArrivalManager.CHINESE_LANG</code>
* @throws InvalidArrivalTargetException If the specified target arrival was invalid
* @throws CouldNotLoadDatabaseException If the API could not load the database
*/
Expand Down Expand Up @@ -213,7 +214,7 @@ public ArrivalTime getArrivalTime(){
* <br>
* Different cases to return another string:<br>
* <b>---</b>: If <code>srvhr</code>, <code>srvmin</code>, <code>arrhr</code>, <code>arrmin</code> is -1<br>
* <b>Arrived</b>: If <code>remainMin</code> <= 0
* <b>Arrived</b>: If <code>remainMin</code> smaller or equal to 0
* @return A String with the format mentioned above
*/
public String getArrivalTimeRemaining_Formatted(){
Expand Down Expand Up @@ -309,7 +310,6 @@ public String getArrivalTime_Formatted() throws NoETADataFetchedError, NoServerT
* <b>Get all the buses of this ArrivalManager's bus stop</b><br>
* <br>
* Returns a list with nothing if no buses match the bus-stop code
* @param stopcode The Bus-Stop code
* @return List
*/
public List<String> getBusStopBuses(){
Expand Down Expand Up @@ -398,6 +398,7 @@ public static boolean generateDatabase(){
* It is automatically called if the database in the memory is <code>null</code>.<br>
* <b>Must be called before any database reading events.</b>
* @param fromClassResources Load from Class-path<br>
* @param parent A class parent to be specified
* If <code>true</code>, make sure the <code>bus_stopdb.properties</code> is attached in the class-path.<br>
* If <code>false</code>, make sure the <code>bus_stopdb.properties</code> is inside the working directory.
* @return Boolean whether the database is successfully loaded.
Expand Down Expand Up @@ -476,6 +477,7 @@ private static int getBusNoIndex(String bus_no){
* <br>
* 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
*/
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/mob41/kmbeta/api/KmbApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,7 @@ public static String[] getFormattedTableData(int bus_index, int stop_index){
* <br>
* 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
*/
Expand Down

0 comments on commit 64ea997

Please sign in to comment.