diff options
| author | Loic Guegan <manzerbredes@mailbox.org> | 2023-05-13 10:43:21 +0200 |
|---|---|---|
| committer | Loic Guegan <manzerbredes@mailbox.org> | 2023-05-13 10:43:21 +0200 |
| commit | 617f2b01b2679ec43330ea6fb5f25f4137565b6a (patch) | |
| tree | f6d102da10821fb04f6184499e8a17cdb96472ad /src/base_tab/gamebase | |
| parent | 055410c0e0c1297612ce9677331d012af2226fac (diff) | |
Improve documentation
Diffstat (limited to 'src/base_tab/gamebase')
| -rw-r--r-- | src/base_tab/gamebase/GameBase.hpp | 4 | ||||
| -rw-r--r-- | src/base_tab/gamebase/PGNGameBase.hpp | 4 |
2 files changed, 8 insertions, 0 deletions
diff --git a/src/base_tab/gamebase/GameBase.hpp b/src/base_tab/gamebase/GameBase.hpp index 1ef5f59..b2c1488 100644 --- a/src/base_tab/gamebase/GameBase.hpp +++ b/src/base_tab/gamebase/GameBase.hpp @@ -3,6 +3,10 @@ #include <algorithm> #include <vector> +/** + * @brief Represent the interface that each database type (such as PGNGameBase) must follow + * to be accessible in OChess. + */ class GameBase { public: diff --git a/src/base_tab/gamebase/PGNGameBase.hpp b/src/base_tab/gamebase/PGNGameBase.hpp index f455ebd..c37e551 100644 --- a/src/base_tab/gamebase/PGNGameBase.hpp +++ b/src/base_tab/gamebase/PGNGameBase.hpp @@ -3,6 +3,10 @@ #include "GameBase.hpp" #include "pgnp.hpp" +/** + * @brief Used to open PGN files + * + */ class PGNGameBase : public GameBase { pgnp::PGN *pgn; bool hasNextGame; |
