From 9275f78bef81b6bff2032d3c988477ee20de5cb1 Mon Sep 17 00:00:00 2001 From: DuarteSAssuncao Date: Thu, 26 Oct 2023 14:23:17 +0100 Subject: [PATCH] Documented file names --- src/Utils.cpp | 2 +- src/Utils.hpp | 4 ++++ src/classes.cpp | 4 ++++ src/classes.hpp | 4 ++++ src/classesPerUC.cpp | 4 ++++ src/classesPerUC.hpp | 5 +++++ src/studentsClasses.cpp | 4 ++++ src/studentsClasses.hpp | 4 ++++ 8 files changed, 30 insertions(+), 1 deletion(-) diff --git a/src/Utils.cpp b/src/Utils.cpp index 4383852..5b817ad 100644 --- a/src/Utils.cpp +++ b/src/Utils.cpp @@ -1,7 +1,7 @@ #include "Utils.hpp" /** - * @file + * @file Utils.cpp * This file defines some functions that are gonna be useful in other classes */ diff --git a/src/Utils.hpp b/src/Utils.hpp index b63db87..f7aebec 100644 --- a/src/Utils.hpp +++ b/src/Utils.hpp @@ -5,6 +5,10 @@ #include #include +/** + * @file Utils.hpp + */ + // djb2 hash : https://theartincode.stanis.me/008-djb2/ uint8_t hash_str(std::string s); bool isnum(uint32_t c); diff --git a/src/classes.cpp b/src/classes.cpp index 31f4691..e3a8f5d 100644 --- a/src/classes.cpp +++ b/src/classes.cpp @@ -4,6 +4,10 @@ using namespace std; +/** + * @file classes.cpp + */ + // Constructor: /** * The constructor reads the line and assigns each string value to its attribute. diff --git a/src/classes.hpp b/src/classes.hpp index 0912e97..6b98a44 100644 --- a/src/classes.hpp +++ b/src/classes.hpp @@ -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. diff --git a/src/classesPerUC.cpp b/src/classesPerUC.cpp index 8657188..224b964 100644 --- a/src/classesPerUC.cpp +++ b/src/classesPerUC.cpp @@ -10,6 +10,10 @@ #include #include +/** + * @file classPerUC.cpp + */ + // Constructor: /** * The constructor reads the line and assigns each string value to its attribute. diff --git a/src/classesPerUC.hpp b/src/classesPerUC.hpp index fd5a897..c26bead 100644 --- a/src/classesPerUC.hpp +++ b/src/classesPerUC.hpp @@ -6,6 +6,11 @@ #ifndef CLASSPERUC_H #define CLASSPERUC_H + +/** + * @file classesPerUC.hpp + */ + void parse_csv_line(std::string s, std::vector &res); class ClassPerUC { protected: diff --git a/src/studentsClasses.cpp b/src/studentsClasses.cpp index 9ee37e6..2cf8289 100644 --- a/src/studentsClasses.cpp +++ b/src/studentsClasses.cpp @@ -7,6 +7,10 @@ #include #include +/** + * @file studentsClasses.cpp + */ + // Constructor /** * The constructor reads the line and assigns each string value to its attribute. diff --git a/src/studentsClasses.hpp b/src/studentsClasses.hpp index 5a33b90..0243565 100644 --- a/src/studentsClasses.hpp +++ b/src/studentsClasses.hpp @@ -4,6 +4,10 @@ #ifndef STUDENTSCLASSES_H #define STUDENTSCLASSES_H +/** + * @file studentsClasses.hpp + */ + class StudentsClasses : public ClassPerUC { private: uint32_t student_code_;