Skip to content

Commit

Permalink
Update JavaDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
pjanthony2001 committed Apr 15, 2024
1 parent 3fc0626 commit 9bde3de
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 13 deletions.
12 changes: 2 additions & 10 deletions src/main/java/seedu/address/ui/EventCard.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,12 @@
import seedu.address.model.event.Event;

/**
* An UI component that displays information of a {@code Person}.
* A UI component that displays information of a {@code Event}.
*/
public class EventCard extends UiPart<Region> {

private static final String FXML = "EventListCard.fxml";

/**
* Note: Certain keywords such as "location" and "resources" are reserved keywords in JavaFX.
* As a consequence, UI elements' variable names cannot be set to such keywords
* or an exception will be thrown by JavaFX during runtime.
*
* @see <a href="https://github.com/se-edu/addressbook-level4/issues/336">The issue on AddressBook level 4</a>
*/

public final Event event;

@FXML
Expand All @@ -35,7 +27,7 @@ public class EventCard extends UiPart<Region> {
private Label description;

/**
* Creates a {@code PersonCode} with the given {@code Person} and index to display.
* Creates a {@code EventCard} with the given {@code Event}.
*/
public EventCard(Event event) {
super(FXML);
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/seedu/address/ui/EventListPanel.java
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import seedu.address.model.event.Event;

/**
* Panel containing the list of persons.
* Panel containing the list of events.
*/
public class EventListPanel extends UiPart<Region> {
private static final String FXML = "EventListPanel.fxml";
Expand All @@ -21,7 +21,7 @@ public class EventListPanel extends UiPart<Region> {
private ListView<Event> eventListView;

/**
* Creates a {@code PersonListPanel} with the given {@code ObservableList}.
* Creates a {@code EventsListPanel} with the given {@code ObservableList}.
*/
public EventListPanel(ObservableList<Event> eventList) {
super(FXML);
Expand All @@ -30,7 +30,7 @@ public EventListPanel(ObservableList<Event> eventList) {
}

/**
* Custom {@code ListCell} that displays the graphics of a {@code Person} using a {@code PersonCard}.
* Custom {@code EventListViewCell} that displays the graphics of a {@code Event} using a {@code EventCard}.
*/
class EventListViewCell extends ListCell<Event> {
@Override
Expand Down

0 comments on commit 9bde3de

Please sign in to comment.