Skip to content

Commit

Permalink
docs: add comments to header file
Browse files Browse the repository at this point in the history
  • Loading branch information
csirianni committed Oct 20, 2023
1 parent fdb250a commit 4a3c312
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions backend/src/database.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,39 @@ namespace database
/**
* @brief Class containing a SQLite database connection
*
* @warning Rule of Three/Five not currently defined for this class.
*/
class Database
{
public:
/**
* @brief Construct a new Database object
*
* @param file_path
* @warning If a file already exists at the provided path, it is replaced.
* @param file_path The path for the .db file.
*/
Database(const std::string &file_path);

/**
* @brief
* @brief Execute the provided SQL command.
*
* @param command
* @param command The command to be executed.
*/
void execute(const std::string &command);

/**
* @brief
* @brief Print the rows of the provided table.
*
* @param table The table to print
*/
void printTable(const std::string &table);

/**
* @brief
* @brief Close the connection with the SQLite database.
*
*/
void close();

/**
* @brief Destroy the Database object
*
Expand Down

0 comments on commit 4a3c312

Please sign in to comment.