diff options
| author | Loic Guegan <manzerbredes@mailbox.org> | 2023-05-12 15:29:04 +0200 |
|---|---|---|
| committer | Loic Guegan <manzerbredes@mailbox.org> | 2023-05-12 15:29:04 +0200 |
| commit | 055410c0e0c1297612ce9677331d012af2226fac (patch) | |
| tree | 6c3789e5d263ad0eec280ce34cdac392a0313436 /tools/doxygen/Libraries.md | |
| parent | a6bfdf40d50c58e9d7337fc0047d2708d5c2b506 (diff) | |
Improve doxygen documentation
Diffstat (limited to 'tools/doxygen/Libraries.md')
| -rw-r--r-- | tools/doxygen/Libraries.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/tools/doxygen/Libraries.md b/tools/doxygen/Libraries.md new file mode 100644 index 0000000..77a6bd0 --- /dev/null +++ b/tools/doxygen/Libraries.md @@ -0,0 +1,24 @@ +Internal Libraries +==== + +Ochess uses 5 internal libraries (excluding [wxWidgets](https://www.wxwidgets.org/)): +- [cgeditor](https://gitlab.com/manzerbredes/cgeditor): A 2D chess game moves presenter/editor +- [pgnp](https://gitlab.com/manzerbredes/pgnp): An efficient PGN parser +- [chessarbiter](https://gitlab.com/manzerbredes/chessarbiter): A chess classical chess game arbiter for C++ +- [uciadapter](https://gitlab.com/manzerbredes/uciadapter): A cross platform utility to interact with UCI chess engines +- [chess-move-interface](https://gitlab.com/manzerbredes/chess-move-interface): A chess half move interface for libraries interoperability + +### CGEditor +It is only used in EditorCanvas. + +### PGNP +It is only used in PGNGameBase. + +### ChessArbiter +Mostly used in Game and HalfMove. + +### UCIAdapter +Used in various engine related areas such as MainWindow, EngineTab and LiveEngineDialog. + +### Chess-Move-Interface +Used in various region of OChess such as PGNGameBase and HalfMove.
\ No newline at end of file |