Skip to content

Commit

Permalink
chore: adjusted javadoc of classes
Browse files Browse the repository at this point in the history
  • Loading branch information
oscar-schwarz committed Jun 22, 2024
1 parent 62af854 commit faf86a7
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions src/main/java/fish_variety/Fish.java
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package fish_variety;

/**
* The Fish class represents a type of fish with a name and price.
*/
package fish_variety;

public class Fish {
private String name;

Expand Down
6 changes: 3 additions & 3 deletions src/main/java/fish_variety/FishCalculator.java
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* The FishCalculator class calculates the most compatible fish types that can be bought within a given price range.
*/
package fish_variety;

import java.util.ArrayList;

/**
* The FishCalculator class calculates the most compatible fish types that can be bought within a given price range.
*/
public class FishCalculator {

/**
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/fish_variety/FishCollection.java
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* Represents a collection of fishes with constraints.
*/
package fish_variety;

import java.util.ArrayList;

/**
* Represents a collection of fishes with constraints.
*/
public class FishCollection {
private ArrayList<Fish> fishes = new ArrayList<Fish>();
private FishConstraints constraints;
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/fish_variety/FishConstraints.java
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/**
* The FishConstraints class represents constraints between different types of fish.
*/
package fish_variety;

import java.util.ArrayList;
import java.util.Arrays;

/**
* The FishConstraints class represents constraints between different types of fish.
*/
public class FishConstraints {
private ArrayList<FishPair> constraints = new ArrayList<FishPair>();
private ArrayList<Fish> fishes;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/fish_variety/FishPair.java
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package fish_variety;

/**
* Represents a pair of fish.
*/
package fish_variety;

public class FishPair {
private Fish first;
private Fish second;
Expand Down

0 comments on commit faf86a7

Please sign in to comment.