Javadoc corrections

diff --git a/src/main/java/de/diejungsvondertanke/tankstelle/FuelStation.java b/src/main/java/de/diejungsvondertanke/tankstelle/FuelStation.java
index 338203af3891f270655499da414c87584d67f91c..8b7658ffa9cc499598562f082c1d97ba21462c87 100644 (file)
--- a/src/main/java/de/diejungsvondertanke/tankstelle/FuelStation.java
+++ b/src/main/java/de/diejungsvondertanke/tankstelle/FuelStation.java
@@ -111,6 +111,7 @@ abstract class FuelStation {
      * Get the price for a specific type of fuel for this fuel station
      * 
      * @param fuel_type The {@link FuelType FuelType} to get
+     * @return The price for a specific type of fuel for this fuel station
      * @throws NoSuchFuelTypeError This Error is thrown on the attempt to choose a
      *                             fuel type from a fuel station
      *                             which the fuel station does not have
@@ -128,7 +129,7 @@ abstract class FuelStation {
      * Get the cumulative price for the amount of fuel stored
      * 
      * => What you would get if you would sell all fuel of this station at the
-     * current prices
+     * current price(s)
      * 
      * @return the income in €
      */
@@ -188,6 +189,7 @@ abstract class FuelStation {
      * Get the fuel amount for a specific type of fuel for this fuel station
      * 
      * @param fuel_type The {@link FuelType FuelType} to get
+     * @return The fuel amount for a specific type of fuel for this fuel station
      * @throws NoSuchFuelTypeError This Error is thrown on the attempt to choose a
      *                             fuel type from a fuel station
      *                             which the fuel station does not have

diff --git a/src/main/java/de/diejungsvondertanke/tankstelle/Main.java b/src/main/java/de/diejungsvondertanke/tankstelle/Main.java
index 8b3ba1fb980d60c5cb28ac4b3eca7ecc063a86f8..13a57195b88c6f0db0e0159071b6b62acdad749f 100644 (file)
--- a/src/main/java/de/diejungsvondertanke/tankstelle/Main.java
+++ b/src/main/java/de/diejungsvondertanke/tankstelle/Main.java
@@ -83,6 +83,9 @@ public class Main {
      * @param fuelType Select the type of fuel
      * 
      * @return a FuelStation (all of type {@link FuelStation})
+     * @throws NoSuchFuelTypeError This Error is thrown on the attempt to choose a
+     *                             fuel type from a fuel station which the fuel
+     *                             station does not have
      */
     public static FuelStation getHighestPrice(FuelType fuelType) throws NoSuchFuelTypeError {
         float highestPrice = fuelStations[0].get_price(fuelType);
@@ -100,9 +103,10 @@ public class Main {
      * Get the FuelStation with the highest price
      * 
      * 
-     * @param fuelType Select the type of fuel
-     * 
      * @return a FuelStation (all of type {@link FuelStation})
+     * @throws NoSuchFuelTypeError This Error is thrown on the attempt to choose a
+     *                             fuel type from a fuel station which the fuel
+     *                             station does not have
      */
     public static FuelStation getHighestAccumulatedValue() throws NoSuchFuelTypeError {
         float highestValue = fuelStations[0].get_cumulative_retail_price();
@@ -123,6 +127,9 @@ public class Main {
      * @param fuelType Select the type of fuel
      * 
      * @return a FuelStation (all of type {@link FuelStation})
+     * @throws NoSuchFuelTypeError This Error is thrown on the attempt to choose a
+     *                             fuel type from a fuel station which the fuel
+     *                             station does not have
      */
     public static FuelStation getHighestStoredAmount(FuelType fuelType) throws NoSuchFuelTypeError {
         float highestAmount = fuelStations[0].getStored_amount(fuelType);
@@ -143,6 +150,9 @@ public class Main {
      * @param fuelType Select the type of fuel
      * 
      * @return a FuelStation (all of type {@link FuelStation})
+     * @throws NoSuchFuelTypeError This Error is thrown on the attempt to choose a
+     *                             fuel type from a fuel station which the fuel
+     *                             station does not have
      */
     public static FuelStation getLowestStoredAmount(FuelType fuelType) throws NoSuchFuelTypeError {
         float lowestAmount = fuelStations[0].getStored_amount(fuelType);