From bbf06ab97b2a5726cc456d8647b882ddf95ffd1f Mon Sep 17 00:00:00 2001 From: pawelsa Date: Tue, 26 May 2026 17:08:56 +0200 Subject: [PATCH 1/8] chore: Cleanup JavaDocs bad syntaxing. --- .../java/edu/ntnu/idi/idatt/model/enums/NewspaperEnum.java | 2 +- src/main/java/edu/ntnu/idi/idatt/model/portfolio/Share.java | 3 ++- .../idi/idatt/model/transaction/TransactionArchive.java | 3 ++- .../ntnu/idi/idatt/service/transaction/SaleCalculator.java | 2 +- src/main/java/edu/ntnu/idi/idatt/session/UserSession.java | 6 +++--- src/main/java/edu/ntnu/idi/idatt/view/SceneFactory.java | 2 +- .../java/edu/ntnu/idi/idatt/view/components/ui/UIAlert.java | 6 +++--- .../edu/ntnu/idi/idatt/view/components/ui/UIFactory.java | 3 ++- src/main/java/edu/ntnu/idi/idatt/view/entry/StartView.java | 2 +- .../ntnu/idi/idatt/view/primary/exchange/ExchangeModel.java | 2 +- .../idi/idatt/view/primary/newspaper/NewspaperModel.java | 2 +- .../idi/idatt/view/primary/newspaper/NewspaperView.java | 2 +- .../idi/idatt/view/primary/portfolio/PortfolioModel.java | 6 +++--- .../view/primary/portfolio/sections/PlayerInfoSection.java | 2 +- .../view/primary/portfolio/viewmodel/PlayerInfoModel.java | 2 +- .../edu/ntnu/idi/idatt/view/primary/stock/StockModel.java | 6 +++--- .../view/primary/transactions/TransactionController.java | 3 +-- .../idatt/view/primary/transactions/TransactionModel.java | 2 +- 18 files changed, 29 insertions(+), 27 deletions(-) diff --git a/src/main/java/edu/ntnu/idi/idatt/model/enums/NewspaperEnum.java b/src/main/java/edu/ntnu/idi/idatt/model/enums/NewspaperEnum.java index 11b8c22..1c09db1 100644 --- a/src/main/java/edu/ntnu/idi/idatt/model/enums/NewspaperEnum.java +++ b/src/main/java/edu/ntnu/idi/idatt/model/enums/NewspaperEnum.java @@ -7,7 +7,7 @@ * Creates static events that can occur within Newspaper. *

* - * @see Newspaper + * {@link Newspaper} */ public enum NewspaperEnum { NEW_PRODUCT( diff --git a/src/main/java/edu/ntnu/idi/idatt/model/portfolio/Share.java b/src/main/java/edu/ntnu/idi/idatt/model/portfolio/Share.java index c828dd6..4be3d3a 100644 --- a/src/main/java/edu/ntnu/idi/idatt/model/portfolio/Share.java +++ b/src/main/java/edu/ntnu/idi/idatt/model/portfolio/Share.java @@ -77,7 +77,8 @@ public BigDecimal getTotalPurchasePrice() { * SaleCalculator.calculateGross() - getTotalPurchasePrice() *

* - * @see Player (Net worth calculation) + * {@link Player} + * * @return BigDecimal current profit. */ public BigDecimal getProfit() { diff --git a/src/main/java/edu/ntnu/idi/idatt/model/transaction/TransactionArchive.java b/src/main/java/edu/ntnu/idi/idatt/model/transaction/TransactionArchive.java index a861539..b766616 100644 --- a/src/main/java/edu/ntnu/idi/idatt/model/transaction/TransactionArchive.java +++ b/src/main/java/edu/ntnu/idi/idatt/model/transaction/TransactionArchive.java @@ -106,7 +106,8 @@ public List getSales() { * Used to calculate player statuses. *

* - * @see Player + * {@link Player} + * * @return int amount of distinct weeks. */ public int countDistinctWeeks() { diff --git a/src/main/java/edu/ntnu/idi/idatt/service/transaction/SaleCalculator.java b/src/main/java/edu/ntnu/idi/idatt/service/transaction/SaleCalculator.java index bcbc17d..aba30e7 100644 --- a/src/main/java/edu/ntnu/idi/idatt/service/transaction/SaleCalculator.java +++ b/src/main/java/edu/ntnu/idi/idatt/service/transaction/SaleCalculator.java @@ -84,7 +84,7 @@ public BigDecimal calculateTotal() { * to the net worth calculation method. *

* - * @see Player + * {@link Player} */ public BigDecimal calculateProfit() { return calculateGross().subtract(purchasePrice.multiply(quantity)); diff --git a/src/main/java/edu/ntnu/idi/idatt/session/UserSession.java b/src/main/java/edu/ntnu/idi/idatt/session/UserSession.java index 05bacf6..d68ebde 100644 --- a/src/main/java/edu/ntnu/idi/idatt/session/UserSession.java +++ b/src/main/java/edu/ntnu/idi/idatt/session/UserSession.java @@ -89,7 +89,7 @@ public void setExchange(Exchange exchange) { /** * Getter for moneyProperty. * - * @return SimpleObjectProperty; + * @return {@code SimpleObjectProperty} */ public SimpleObjectProperty moneyProperty() { return moneyProperty; @@ -98,7 +98,7 @@ public SimpleObjectProperty moneyProperty() { /** * Getter for netWorthProperty. * - * @return SimpleObjectProperty + * @return {@code SimpleObjectProperty} */ public SimpleObjectProperty netWorthProperty() { return netWorthProperty; @@ -126,7 +126,7 @@ public SimpleStringProperty statusProperty() { * Method used for updating the game state. *

* Updates the user interface model from diverse - * places through the code to synchronize model <-> UI. + * places through the code to synchronize model with UI. * Saves current session. *

*/ diff --git a/src/main/java/edu/ntnu/idi/idatt/view/SceneFactory.java b/src/main/java/edu/ntnu/idi/idatt/view/SceneFactory.java index 154e11b..e04ded5 100644 --- a/src/main/java/edu/ntnu/idi/idatt/view/SceneFactory.java +++ b/src/main/java/edu/ntnu/idi/idatt/view/SceneFactory.java @@ -220,7 +220,7 @@ public static Parent createExchangeView() { *

* * @param clean - should it reset the page stack. - * @rteturn View's root + * @return View's root */ public static Parent createExchangeView(boolean clean) { return createDefaultExchangeView(clean); diff --git a/src/main/java/edu/ntnu/idi/idatt/view/components/ui/UIAlert.java b/src/main/java/edu/ntnu/idi/idatt/view/components/ui/UIAlert.java index a6d9556..f96b490 100644 --- a/src/main/java/edu/ntnu/idi/idatt/view/components/ui/UIAlert.java +++ b/src/main/java/edu/ntnu/idi/idatt/view/components/ui/UIAlert.java @@ -16,9 +16,9 @@ public class UIAlert { /** * Constructor for UIAlert. * - * @param title - Window name - * @param header - context - * @content - description of context + * @param title - Window name + * @param header - context + * @param content - description of context */ public UIAlert(String title, String header, String content) { alert.setTitle(title); diff --git a/src/main/java/edu/ntnu/idi/idatt/view/components/ui/UIFactory.java b/src/main/java/edu/ntnu/idi/idatt/view/components/ui/UIFactory.java index 06ba4c8..97e9120 100644 --- a/src/main/java/edu/ntnu/idi/idatt/view/components/ui/UIFactory.java +++ b/src/main/java/edu/ntnu/idi/idatt/view/components/ui/UIFactory.java @@ -7,6 +7,7 @@ import edu.ntnu.idi.idatt.session.UserSession; import edu.ntnu.idi.idatt.view.SceneFactory; +import edu.ntnu.idi.idatt.view.components.AbstractViewUI; import edu.ntnu.idi.idatt.view.components.elements.IconComponent; import edu.ntnu.idi.idatt.view.components.elements.SearchBarComponent; import edu.ntnu.idi.idatt.view.components.primitives.ActionEventHandler; @@ -33,7 +34,7 @@ * equal layouts across multiple views. *

* - * @see AbstractViewUI + * {@link AbstractViewUI} */ public class UIFactory { diff --git a/src/main/java/edu/ntnu/idi/idatt/view/entry/StartView.java b/src/main/java/edu/ntnu/idi/idatt/view/entry/StartView.java index ece4e5a..3f05ecf 100644 --- a/src/main/java/edu/ntnu/idi/idatt/view/entry/StartView.java +++ b/src/main/java/edu/ntnu/idi/idatt/view/entry/StartView.java @@ -45,7 +45,7 @@ public StartView() { /** * Overriden method for createContent() * - * @see AbstractView; + * @see AbstractView * @return root node. */ @Override diff --git a/src/main/java/edu/ntnu/idi/idatt/view/primary/exchange/ExchangeModel.java b/src/main/java/edu/ntnu/idi/idatt/view/primary/exchange/ExchangeModel.java index f7bf431..ac4d1c4 100644 --- a/src/main/java/edu/ntnu/idi/idatt/view/primary/exchange/ExchangeModel.java +++ b/src/main/java/edu/ntnu/idi/idatt/view/primary/exchange/ExchangeModel.java @@ -17,7 +17,7 @@ public class ExchangeModel implements Model { /** * Getter for the stock list. * - * @return ObservableList; + * @return {@code ObservableList} */ public ObservableList getStockList() { return stockList; diff --git a/src/main/java/edu/ntnu/idi/idatt/view/primary/newspaper/NewspaperModel.java b/src/main/java/edu/ntnu/idi/idatt/view/primary/newspaper/NewspaperModel.java index e5499be..0df8b7d 100644 --- a/src/main/java/edu/ntnu/idi/idatt/view/primary/newspaper/NewspaperModel.java +++ b/src/main/java/edu/ntnu/idi/idatt/view/primary/newspaper/NewspaperModel.java @@ -14,7 +14,7 @@ public class NewspaperModel implements Model { /** * Getter for newsList. * - * @return ObservableList