diff --git a/hjelpeFunksjoner.cpp b/hjelpeFunksjoner.cpp index 15a4d77ff7fc0dedd99ae625e740e3134ae3cf29..3adb26f14606b25c93d49a2be7b11e920e1630f4 100644 --- a/hjelpeFunksjoner.cpp +++ b/hjelpeFunksjoner.cpp @@ -2,6 +2,12 @@ using namespace std; +/** + * Fjerner uønskede tegn fra en string. + * + * @param str - Stringen som skal renses. + * @return string - Renset streng. + */ string HjelpeFunksjoner::rensStreng(const string str) { string rensetStreng, tmp, tmp2; int i = 0; @@ -45,6 +51,13 @@ string HjelpeFunksjoner::rensStreng(const string str) { return rensetStreng; } +/** + * Sjekker om en streng inneholder ulovlige/uønskede tegn. + * + * @param str - Strngen som skal sjekkes. + * @return true - Hvis strengen har ulovlige tegn. + * @return false - Hvis strengen ikke har noen ulovlige tegn. + */ bool HjelpeFunksjoner::sjekkForUlovligTegn(const string str) { regex re("[^ÆØÅæøåa-zA-Z0-9 ]"); if (regex_search(str, re)) { @@ -55,6 +68,13 @@ bool HjelpeFunksjoner::sjekkForUlovligTegn(const string str) { return false; } +/** + * Sjekker om en streng inneholder alfanumeriske tegn. + * + * @param str - Stringen som skal sjekkes. + * @return true - Hvis den innholder en eller flere bokstaver. + * @return false - Hvis den ikke inneholder noen bokstaver. + */ bool HjelpeFunksjoner::erBokstav(const string str) { auto it = find_if(str.begin(), str.end(), [](const char& val) { return isalpha(val) == true; }); @@ -66,6 +86,12 @@ bool HjelpeFunksjoner::erBokstav(const string str) { return false; } +/** + * Gjør om alle bokstaver i en streng til Store bokstaver. + * + * @param str - Stringen som skal endres. + * @return string - Endret streng. + */ string HjelpeFunksjoner::gjorOmTilStorBokstav(const string& str) { string tmp = ""; for (const auto& val : str) { @@ -74,6 +100,13 @@ string HjelpeFunksjoner::gjorOmTilStorBokstav(const string& str) { return tmp; } +/** + * Splitter en streng på char'en gitt som input parameter. + * + * @param splittPa - Tegnet stringen skal splittes på. + * @param str - Stringen som skal splittes. + * @return vector<string> - Splittet streng. + */ vector<string> HjelpeFunksjoner::splittStreng(const char& splittPa, const string& str) { vector<string> split; string tmp = ""; @@ -88,6 +121,12 @@ vector<string> HjelpeFunksjoner::splittStreng(const char& splittPa, const string return split; } +/** + * Legger til 0 foran time og minutt hvis de er lavere enn 9. + * + * @param time - Time. + * @param min - Minutt(er). + */ void HjelpeFunksjoner::skrivKlokkeslett(const int& time, const int& min) { if (time <= 9) cout << "0" << time; @@ -100,7 +139,13 @@ void HjelpeFunksjoner::skrivKlokkeslett(const int& time, const int& min) { cout << min; } -// Basert på Frodes lesInt() funk fra lesData3.cpp +/** + * Basert på Frodes lesInt() funk fra lesData3.cpp + * + * Leser inn en int, looper helt til et tall tastes inn. + * + * @return int - Inntastet tall. + */ int HjelpeFunksjoner::lesTall() { char buffer[MAX_CHAR] = ""; int tall = 0; @@ -112,7 +157,7 @@ int HjelpeFunksjoner::lesTall() { tall = atoi(buffer); if (tall == 0 && buffer[0] != '0') { feil = true; - std::cout << "\nError: Ikke et tall!" << '\n'; + cout << "\nError: Ikke et tall!" << '\n'; } } while (feil); diff --git a/hjelpeFunksjoner.h b/hjelpeFunksjoner.h index 82a3c21a5ef2cf1d2d5b7c4b87ed21d703063c43..d88e882ff611539a0b1572038e2a7ed488bfcb85 100644 --- a/hjelpeFunksjoner.h +++ b/hjelpeFunksjoner.h @@ -9,6 +9,10 @@ #include "konstanter.h" +/** + * HjelpeFunksjoner klasse. + * + */ class HjelpeFunksjoner { public: std::string rensStreng(std::string str);