Skip to content
This repository has been archived by the owner on Nov 6, 2023. It is now read-only.

Commit

Permalink
Documented constructors
Browse files Browse the repository at this point in the history
  • Loading branch information
DuarteSAssuncao committed Oct 26, 2023
1 parent e6ddaed commit 89a6365
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/appClasses.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
* @file appClasses.cpp
*/

/**
* This constructor receives a string containing all the lines of a csv file and creates the AppClass from it.
* @param csv
*/
AppClass::AppClass(const std::string& csv) {
// CSV file into memory
std::ifstream file = std::ifstream(csv);
Expand Down
6 changes: 6 additions & 0 deletions src/appClassesPerUC.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@
* @file appClassesPerUC.cpp
*/

/**
* This constructor receives a string containing all the lines of a csv file and creates the AppClassPerUC from it.
* The cap parameter is the capacity of each class.
* @param csv
* @param cap
*/
AppClassPerUC::AppClassPerUC(const std::string& csv, uint8_t cap) {
this->cap = cap;

Expand Down
4 changes: 4 additions & 0 deletions src/appStudentsClasses.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
*/

// Constructor
/**
* This constructor receives a string containing all the lines of a csv file and creates the AppSudentClass from it.
* @param csv
*/
AppStudentsClasses::AppStudentsClasses(const std::string& csv) {
// CSV file into memory
std::ifstream file = std::ifstream(csv);
Expand Down

0 comments on commit 89a6365

Please sign in to comment.