From bf7689ba06764b72a6212549a5c8a39e294cceee Mon Sep 17 00:00:00 2001 From: Syndamia Date: Sun, 8 May 2022 20:40:30 +0300 Subject: Fully documented all Models --- src/Models/Ticket.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'src/Models/Ticket.h') diff --git a/src/Models/Ticket.h b/src/Models/Ticket.h index fb242e3..06b4571 100644 --- a/src/Models/Ticket.h +++ b/src/Models/Ticket.h @@ -1,26 +1,41 @@ #ifndef HEADER_HEADER_TICKET #define HEADER_HEADER_TICKET +/*! \file Ticket.h + * \brief Stores the declaration of class Ticket + */ + #include #include +/*! \brief Each Ticket contains a row and a seat number + */ class Ticket { unsigned row; unsigned seat; public: + //! Sets row and seat to zeroes Ticket(); + //! Sets row and seat Ticket(unsigned row, unsigned seat); + //! Returns row unsigned get_row() const; + //! Returns seat unsigned get_seat() const; + //! Reads Ticket from stram void read(std::istream& istr); + //! Writes Ticket to stream void write(std::ostream& ostr) const; + //! Compares two Tickets int compare(const Ticket& other) const; }; +//! Reads Ticket from stream with >> operator std::istream& operator>>(std::istream& istr, Ticket& ticket); +//! Writes Ticket to stream with << operator std::ostream& operator<<(std::ostream& ostr, const Ticket& ticket); #endif -- cgit v1.3.1-26-gb76a