From 9bde3deef36f979adfc37746f788f9013af84802 Mon Sep 17 00:00:00 2001 From: pjanthony2001 <104015990+pjanthony2001@users.noreply.github.com> Date: Mon, 15 Apr 2024 22:57:27 +0800 Subject: [PATCH] Update JavaDocs --- src/main/java/seedu/address/ui/EventCard.java | 12 ++---------- src/main/java/seedu/address/ui/EventListPanel.java | 6 +++--- 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/src/main/java/seedu/address/ui/EventCard.java b/src/main/java/seedu/address/ui/EventCard.java index eba83644b37..4882471de46 100644 --- a/src/main/java/seedu/address/ui/EventCard.java +++ b/src/main/java/seedu/address/ui/EventCard.java @@ -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 { 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 The issue on AddressBook level 4 - */ - public final Event event; @FXML @@ -35,7 +27,7 @@ public class EventCard extends UiPart { 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); diff --git a/src/main/java/seedu/address/ui/EventListPanel.java b/src/main/java/seedu/address/ui/EventListPanel.java index 5f3c82f5492..3115bb47324 100644 --- a/src/main/java/seedu/address/ui/EventListPanel.java +++ b/src/main/java/seedu/address/ui/EventListPanel.java @@ -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 { private static final String FXML = "EventListPanel.fxml"; @@ -21,7 +21,7 @@ public class EventListPanel extends UiPart { private ListView eventListView; /** - * Creates a {@code PersonListPanel} with the given {@code ObservableList}. + * Creates a {@code EventsListPanel} with the given {@code ObservableList}. */ public EventListPanel(ObservableList eventList) { super(FXML); @@ -30,7 +30,7 @@ public EventListPanel(ObservableList 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 { @Override