Skip to content

Commit 3021c60

Browse files
marko-radosavljevicZabuzard
authored andcommitted
Add notes to the interface javadocs
1 parent 10ddfbc commit 3021c60

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

Contest/Assignment/src/org/togetherjava/event/elevator/elevators/FloorPanelSystem.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@
66
public interface FloorPanelSystem {
77
/**
88
* Requests an elevator to move to the given floor to pick up a human.
9-
* @param atFloor the floor to pick up the human at, must be within the range served by the system
9+
*
10+
* @param atFloor the floor to pick up the human at, must be within the range served by the system
1011
* @param desiredTravelDirection the direction the human wants to travel into,
1112
* can be used for determination of the best elevator
13+
* @apiNote This represents a human standing in the corridor, pressing a button on the wall,
14+
* requesting that an elevator comes to pick them up for travel into the given direction.
1215
*/
1316
void requestElevator(int atFloor, TravelDirection desiredTravelDirection);
1417
}

Contest/Assignment/src/org/togetherjava/event/elevator/humans/ElevatorListener.java

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ public interface ElevatorListener {
2121
*
2222
* @param elevatorPanel the system inside the elevator which provides information
2323
* about the elevator and can be used to request a destination floor.
24+
* @implNote The default implementation fires this event from all elevators to all humans, not only to humans that are
25+
* relevant (i.e. humans that can enter the elevator).
2426
*/
2527
void onElevatorArrivedAtFloor(ElevatorPanel elevatorPanel);
2628
}

0 commit comments

Comments
 (0)