Skip to content

Commit

Permalink
📚 Doxygen: added codebase overview page
Browse files Browse the repository at this point in the history
  • Loading branch information
ohlidalp authored and Petr Ohlídal committed Apr 9, 2022
1 parent 185d106 commit 70b695e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/doxygen/Doxyfile.conf.in
Original file line number Diff line number Diff line change
Expand Up @@ -762,6 +762,7 @@ WARN_LOGFILE =
# Note: If this tag is empty the current directory is searched.

INPUT = @DOXYGEN_SOURCE_DIR@/MainPage.h \
@DOXYGEN_SOURCE_DIR@/Overview.h \
@PROJECT_SOURCE_DIR@/source

# This tag can be used to specify the character encoding of the source files
Expand Down
22 changes: 22 additions & 0 deletions doc/doxygen/Overview.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*!
* @page Codebase overview
*
* # The application
*
* Rigs of Rods is a monolithic C++ program with it's own main input/rendering loop.
* The entry point is a standard main() function which performs all initialization, message processing and cleanup.
*
* # Input handling
* Inputs are received via OIS library's listener mechanism.
* Class RoR::AppContext is the sole listener for all inputs and serves as a dispatcher between various subsystems.
* Gameplay inputs are defined by enum events and handled by InputEngine. RoR::InputEngine also reads input configuration files '*.map', the default being 'input.map'.
*
* # Rendering
* Graphical output is done via OGRE 3D rendering engine (not to be confused with game engine).
* Startup is done by RoR::AppContext::SetUpRendering().
* Window events are handled by RoR::AppContext via OGRE's OgreBites::WindowEventListener. Note Ogre::FrameListener interface is not used, we roll our own rendering loop in main().
*
*
*
*
*/

0 comments on commit 70b695e

Please # to comment.