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

Commit

Permalink
Documented file names
Browse files Browse the repository at this point in the history
  • Loading branch information
DuarteSAssuncao committed Oct 26, 2023
1 parent 00049d9 commit 9275f78
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/Utils.cpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#include "Utils.hpp"

/**
* @file
* @file Utils.cpp
* This file defines some functions that are gonna be useful in other classes
*/

Expand Down
4 changes: 4 additions & 0 deletions src/Utils.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
#include <vector>
#include <sstream>

/**
* @file Utils.hpp
*/

// djb2 hash : https://theartincode.stanis.me/008-djb2/
uint8_t hash_str(std::string s);
bool isnum(uint32_t c);
Expand Down
4 changes: 4 additions & 0 deletions src/classes.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

using namespace std;

/**
* @file classes.cpp
*/

// Constructor:
/**
* The constructor reads the line and assigns each string value to its attribute.
Expand Down
4 changes: 4 additions & 0 deletions src/classes.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
#ifndef CLASS_HPP
#define CLASS_HPP

/**
* @file classes.hpp
*/

/**
* Since it is quicker to compare numbers instead of strings and there are only 7 days in a week, we decided to store
* the days as objects of this class.
Expand Down
4 changes: 4 additions & 0 deletions src/classesPerUC.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
#include <string>
#include <vector>

/**
* @file classPerUC.cpp
*/

// Constructor:
/**
* The constructor reads the line and assigns each string value to its attribute.
Expand Down
5 changes: 5 additions & 0 deletions src/classesPerUC.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@

#ifndef CLASSPERUC_H
#define CLASSPERUC_H

/**
* @file classesPerUC.hpp
*/

void parse_csv_line(std::string s, std::vector<std::string> &res);
class ClassPerUC {
protected:
Expand Down
4 changes: 4 additions & 0 deletions src/studentsClasses.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
#include <iomanip>
#include <sstream>

/**
* @file studentsClasses.cpp
*/

// Constructor
/**
* The constructor reads the line and assigns each string value to its attribute.
Expand Down
4 changes: 4 additions & 0 deletions src/studentsClasses.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
#ifndef STUDENTSCLASSES_H
#define STUDENTSCLASSES_H

/**
* @file studentsClasses.hpp
*/

class StudentsClasses : public ClassPerUC {
private:
uint32_t student_code_;
Expand Down

0 comments on commit 9275f78

Please sign in to comment.