From a6bfdf40d50c58e9d7337fc0047d2708d5c2b506 Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Thu, 11 May 2023 21:35:06 +0200 Subject: Setting up doxygen --- tools/doxygen/MainPage.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 tools/doxygen/MainPage.md (limited to 'tools/doxygen/MainPage.md') diff --git a/tools/doxygen/MainPage.md b/tools/doxygen/MainPage.md new file mode 100644 index 0000000..a78dff1 --- /dev/null +++ b/tools/doxygen/MainPage.md @@ -0,0 +1,12 @@ +Main Page {#mainpage} +===== + +### Entry point +The entry point of the OChess application can be found in the `ochess.cpp` and `ochess.hpp` files. The starting code of the application is implemented in the [OnInit method](@ref MyApp::OnInit()). + +### GUI files +The GUI files are `gui.h` and `gui.cpp`. These files **MUST NOT** be modified directly. +They are generated by [wxFormBuilder](https://github.com/wxFormBuilder/wxFormBuilder). Hence, any graphical components related modifications must be made using wxFormBuilder. + +### Main window +The main window implementation can be found in the `MainWindow.hpp` and `MainWindow.cpp` files. \ No newline at end of file -- cgit v1.2.3