Website Summary Files Commits Branches @commit @diff @stats
path: root / src / Generic / Date / Date.h
diff options
context:
space:
mode:
Commita8388cfdc47386dcb61f1b5bb9190ce382bf3f1d (patch)
Author
 Syndamia <kamen.d.mladenov@protonmail.com>
2022-05-08 19:50:18 +0300
Committer
 Syndamia <kamen.d.mladenov@protonmail.com>
2022-05-08 19:50:18 +0300
Files9c884826aaffc94664e9e053919336feccfbaeae /src/Generic/Date/Date.h
FMI-OOP-P1_TicketSystem-a8388cfdc47386dcb61f1b5bb9190ce382bf3f1d.tar
FMI-OOP-P1_TicketSystem-a8388cfdc47386dcb61f1b5bb9190ce382bf3f1d.tar.gz
FMI-OOP-P1_TicketSystem-a8388cfdc47386dcb61f1b5bb9190ce382bf3f1d.zip
Parentde678e3a54bdcb776edb43179ff39e02ffb15d8e (diff)
Fully documented generic classes
1 files changed, 21 insertions, 0 deletions
-rw-r--r--src/Generic/Date/Date.h21
diff --git a/src/Generic/Date/Date.h b/src/Generic/Date/Date.h
index cb86e5f..89cc89c 100644
--- a/src/Generic/Date/Date.h
+++ b/src/Generic/Date/Date.h
@@ -1,10 +1,16 @@
#ifndef HEADER_DATE
#define HEADER_DATE
+/*! \file Date.h
+ * \brief Stores the declaration of class Date
+ */
+
#include <istream>
#include <ostream>
#include "../String/String.h"
+/*! \brief Stores a day, month and year
+ */
class Date {
unsigned short day;
unsigned short month;
@@ -14,25 +20,40 @@ class Date {
unsigned short daysInMonth();
public:
+ //! Sets date as 01 May 2022
Date();
+ //! Parses string
Date(const char* str);
+ //! Sets day, month and year
Date(unsigned short day, unsigned short month, unsigned short year);
+ //! Returns the day
unsigned short get_day() const;
+ //! Sets the day
bool set_day(unsigned short day);
+ //! Returns the month
unsigned short get_month() const;
+ //! Sets the month
bool set_month(unsigned short month);
+ //! Returns the year
unsigned short get_year() const;
+ //! Sets the year
bool set_year(unsigned short year);
+ //! Returns the date as a String object
String createString() const;
+ //! Reads date from stream
void read(std::istream& istr);
+ //! Writes date to stream
void write(std::ostream& ostr);
+ //! Compares two dates
int compare(const Date& other) const;
};
+//! Reads date from stream with >> operator
std::istream& operator>>(std::istream& istr, Date& dt);
+//! Writes date to stream with << operator
std::ostream& operator<<(std::ostream& ostr, const Date& dt);
#endif