Adding documentation

This commit is contained in:
AnonymusRaccoon
2020-01-27 19:02:49 +01:00
parent c1cfcf6881
commit ab71231fd8
4 changed files with 41 additions and 1 deletions
+23
View File
@@ -0,0 +1,23 @@
//
// Created by anonymus-raccoon on 1/27/20.
//
#ifndef COMSQUARE_INVALIDADDRESS_HPP
#define COMSQUARE_INVALIDADDRESS_HPP
#include <exception>
#include <string>
namespace ComSquare
{
//! @brief Exception thrown when trying to read/write to an invalid address.
class InvalidAddress : std::exception {
private:
std::string _msg;
public:
explicit InvalidAddress(const std::string &msg) : _msg(msg) {}
const char *what() const noexcept override { return this->_msg.c_str(); }
};
}
#endif //COMSQUARE_INVALIDADDRESS_HPP
@@ -9,6 +9,7 @@
namespace ComSquare
{
//! @brief When this is thrown, it means that we should work more.
class NotImplementedException : std::exception {
public:
explicit NotImplementedException() = default;