Skip to content

Commit

Permalink
chore[wrapper]: add more proper JavaDoc to the Wrapper class description
Browse files Browse the repository at this point in the history
  • Loading branch information
Fredrik Marjoni committed Apr 23, 2026
1 parent 2330f3a commit 75915e5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
4 changes: 3 additions & 1 deletion src/main/java/edu/group5/app/model/wrapper/DbWrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
import java.util.logging.Logger;

/**
* A class for wrapping the database.
* A class for wrapping the database. It provides methods for connecting and disconnecting to the database,
* importing and exporting users and donations, and handling SQL exceptions.
* The class uses a logger to log important events and exceptions that occur during database operations.
*/
public class DbWrapper {
protected Connection connection;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
import tools.jackson.databind.ObjectMapper;

/**
* A Class for Wrapping an API.
* A Class for Wrapping an API.
* It provides methods for importing data from the API and accessing the imported data.
*/
public class OrgApiWrapper extends Wrapper {
private Object[] data;
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/edu/group5/app/model/wrapper/Wrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

/**
* An abstract class for all Wrappers of datasets.
* This class defines the structure for dataset wrappers, which are responsible for importing data from various sources
* and providing access to the imported data. Each wrapper must implement the importData method to handle the specific
* data import logic and the getData method to return the imported data in a suitable format.
*/
abstract class Wrapper {

Expand Down

0 comments on commit 75915e5

Please sign in to comment.