Now v0.1.4. New Readme. Updated docs.

CMakeLists.txt

@@ -4,7 +4,7 @@ project (OpenRaider)
 # Version Number
 set (OpenRaider_VERSION_MAJOR 0)
 set (OpenRaider_VERSION_MINOR 1)
-set (OpenRaider_VERSION_MICRO 3)
+set (OpenRaider_VERSION_MICRO 4)
 set (OpenRaider_VERSION_RELEASE -git)
 
 # Build Host

ChangeLog.md

@@ -1,5 +1,12 @@
 # OpenRaider Developer Branch ChangeLog 
 
+## OpenRaider (0.1.4) xythobuz <xythobuz@xythobuz.de>
+
+    [ 20140313 ]
+    * Renderer now limits room list size
+    * Updated Doxyfile template to current Doxygen version
+    * Improved documentation
+
 ## OpenRaider (0.1.3) xythobuz <xythobuz@xythobuz.de>
 
     [ 20140312 ]

README.md

@@ -1,162 +1,91 @@
 # OpenRaider
 
-[![Build Status](https://travis-ci.org/xythobuz/OpenRaider.svg?branch=loader)](https://travis-ci.org/xythobuz/OpenRaider)
+[![Build Status](https://travis-ci.org/xythobuz/OpenRaider.svg?branch=master)](https://travis-ci.org/xythobuz/OpenRaider)
 
-__This is the development branch of OpenRaider! Currently in the process of moving to OpenGL 3.3...__
+This project started as a fork of the [OpenRaider](http://openraider.sourceforge.net) Open Source implementation of the classic Tomb Raider Game Engine. The original project was abandoned in 2003. In the meantime, this OpenRaider has become a full rewrite of the original.
 
-This is a fork of the [OpenRaider](http://openraider.sourceforge.net) Open Source implementation of the classic Tomb Raider Game Engine. The original project was abandoned in 2003.
+OpenRaider currently supports TR1, TR2 and TR3 files, as well as custom maps based on these engines.
 
-This fork aims to get OpenRaider in a more usable state, maybe one day even being able to play the old Tomb Raider games flawlessly, while bringing the code to modern standards.
-
-Visit the IRC Channel `#OpenRaider` on `chat.freenode.net`. [Webchat](http://webchat.freenode.net/?channels=%23OpenRaider).
-
-It seems as if OpenRaider will currently only work on Little-Endian platforms. This is not nice and will hopefully be fixed in the future!
+Visit the IRC Channel `#OpenRaider` on `chat.freenode.net` ([Webchat](http://webchat.freenode.net/?channels=%23OpenRaider)).
 
 [![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=xythobuz&url=https://github.com/xythobuz/OpenRaider&title=OpenRaider&language=&tags=github&category=software)
 
-## Installation
-
-You can get some not-so-recent Mac releases [on the GitHub page](https://github.com/xythobuz/OpenRaider/releases).
-
-The most recent OpenRaider version can be found on the [Arch Linux User Repos](https://aur.archlinux.org/packages/openraider-git/). Install it with your favorite aur-helper like this: `yaourt -S openraider-git`.
-
-## Configuration
-
-OpenRaider needs some configuration files, and level data and assets from custom levels or the Tomb Raider games.
-These are stored in `~/.OpenRaider`. Running `make setup` will create/copy the necessary files and directories.
-
-You still need to add level files in `~/.OpenRaider/paks/`.
-Dust off your old Tomb Raider CDs or grab some [custom levels](http://www.aspidetr.com/levels/yvel-woods-v1-5/) from the interwebs.
-
-## Documentation
-
-All previously included documentation was moved into the [OpenRaider Repo Wiki](https://github.com/xythobuz/OpenRaider/wiki/_pages).
-
-A more or less recent [Doxygen documentation](http://xythobuz.github.io/OpenRaider/) of OpenRaider should be on the Github Pages for OpenRaider.
-
 ## Dependencies
 
-Basically, OpenRaider depends on the following:
-
-* C++11 compiler
-* cmake (>= 2.8.8)
-* OpenGL (3.3 Core Profile compatible)
-* GLM (>= 0.9.6)
-* zlib
-* SDL2 or GLFW
-* OpenAL & ALUT (optional, needed for sound output)
-
-On Mac OS X 10.9 / 10.10 with [XCode](https://developer.apple.com/xcode/) and [MacPorts](http://www.macports.org) installed, the following should be enough to get all dependencies that are available as port:
-
-    sudo port install cmake zlib glm libsdl2
+* [C++11 compatible compiler](http://en.cppreference.com/w/cpp/compiler_support)
+* [OpenGL](https://www.opengl.org) (3.3 Core Profile compatible)
+* [cmake](http://www.cmake.org) (>= 2.8.8)
+* [GLM](http://glm.g-truc.net) (>= 0.9.6)
+* [SDL2](http://www.libsdl.org) or [GLFW](http://www.glfw.org)
+* [OpenAL](http://www.openal.org) & [ALUT](https://github.com/vancegroup/freealut) (optional, needed for sound output)
 
-A similar command for the package manager of your favorite Linux Distribution should do the trick.
+Mac OS X with XCode and [MacPorts](http://www.macports.org) installed (or replace `libsdl2` by `glfw`):
 
-cmake is also needed to build [freealut](https://github.com/vancegroup/freealut), which you'll need to enable sound output on Mac OS X.
-Get, compile and install freealut like this:
-
-    git clone git@github.com:vancegroup/freealut.git
-    mkdir build
-    cd build
-    cmake .. -DCMAKE_INSTALL_PREFIX:STRING="/usr/local" -DCMAKE_C_FLAGS:STRING="-O2"
-    make
-    sudo make install
-
-Linux Distributions will probably provide an ALUT library ready to install with their package manager, so you won't need to compile freealut.
-
-Sound support is optional, however. If cmake can’t find OpenAL and ALUT, Audio will be deactivated. If you want to explicitly deactivate it, call cmake with `-DENABLE_AUDIO=NO`.
-
-There is also a windowing implementation using GLFW. It will be used if GLFW is found instead of SDL2, or if you call cmake with `-DFORCE_GLFW=YES`. Be aware that your experience will not be as nice as with SDL2...
+    sudo port install cmake glm libsdl2
 
 ## Building
 
-Do a standard cmake out-of-source build to get a debug configuration and then run the resulting executable:
+The basic steps needed to build and run OpenRaider:
 
+    git clone https://github.com/xythobuz/OpenRaider.git
     mkdir build && cd build
-    cmake ..
+    cmake ../OpenRaider
     make run
 
-On Mac OS X, running `make install` will produce a (more or less) distributable OpenRaider.app bundle, which will be put into /Applications.
-
-On Linux, running `make install` will install OpenRaider to /usr/local/... (the executable in bin, the data files in share). You can change this path with `cmake -DCMAKE_INSTALL_PREFIX=”/some/where” ..`
-
-Run `make check` to build and run the unit tests.
-
-You can run a static analysis with cppcheck using `make cppcheck`, `make cppcheckFull` or `make cppcheckConfig`.
-
-A Doxygen API documentation can be created with `make doc`.
+If cmake can’t find OpenAL and ALUT, Sound support will be deactivated. If you want to explicitly deactivate it, call cmake with `-DENABLE_AUDIO=NO`.
 
-`make clean` should remove all intermediary files. `make run` will run the binary.
+GLFW will be used if it is found instead of SDL2, or if you call cmake with `-DFORCE_GLFW=YES`. Be aware that limited controller support is currently only included when building with SDL2.
 
-You can also generate working XCode Project files with `cmake -G Xcode ..`.
+Running `make install` on Linux will install OpenRaider to /usr/local/... (the executable in bin, the data files in share). You can change this path by passing `-DCMAKE_INSTALL_PREFIX=”/some/where”` to cmake.
 
-## Usage
+Running `make install` on Mac OS X will produce a distributable OpenRaider.app bundle that includes all linked shared libraries, so it can be run without installing any dependencies.
 
-### Configuration file
+Run `make check` to execute the included Unit Tests.
 
-OpenRaider will try to load `~/.OpenRaider/OpenRaider.ini` or, if it doesn't exist, `OpenRaider.ini` from the current directory.
+Run `make cppcheck`, `make cppcheckFull` or `make cppcheckConfig` to run a static analysis using cppcheck.
 
-Running `make setup` will create a minimal configuration in your home directory.
+Run `make format` to auto-indent and format all source files using astyle.
 
-The configuration file format is very simple:
-* Every line will be executed as in-game console command
-* The # character marks the beginning of a single-line comment
+Run `make doc` to create a doxygen documentation.
 
-### Level PAKs
-
-You can use paks from any classic Tomb Raider Game (1 - 5) and most user made paks for Tomb Raider. Tomb Raider 5 support is however still very limited.
-
-### Sound FXs
-
-TR2 and TR3 paks (both have file extension `.tr2`) don't have sound data contained in the pak itself, but instead
-they share a common SFX file (often MAIN.SFX) for each pak from a given Tomb Raider version.
-
-OpenRaider tries to load a `MAIN.SFX` from the same folder as the selected level file.
-
-### Default Key Bindings
+## Configuration
 
-| Key               | Action                |
-| -----------------:|:--------------------- |
-| <Esc>       | Toggle menu           |
-| q                 | Toggle debug windows  |
-| w                 | Move forward          |
-| s                 | Move back             |
-| a                 | Move left             |
-| d                 | Move right            |
-| <space>     | Jump                  |
-| <left ctrl> | crouch                |
-| Mouse             | Turn                  |
-| MouseBtn Left     | Shoot/Use             |
-| MouseBtn Right    | Holster/Equip weapons |
+OpenRaider is still somewhat depending on some configuration and data files. These can be stored in different locations, the most common one being `~/.OpenRaider`. Running `make setup` will create/copy the necessary files and directories and an example configuration.
 
-### Console/Config Commands
+Place the asset files of your Tomb Raider games in the pak folder created in `~./OpenRaider`. Don’t forget to copy at least the maps, the `TOMBPC.DAT` script (TR2/TR3 only) and the sound file `MAIN.SFX` (TR2/TR3 only).
 
-Every available command should be listed in the in-game help. Just type `help` in the OpenRaider console, which can be activated by default with the backquote key.
+Currently, you can load single level files, but the game script included with the Tomb Raider games will be read as well, if available. In the future, OpenRaider will hopefully be able to read disc images of the Tomb Raider games as well. Also, OpenRaider should run without a prepared config file in the future.
 
-### Tomb Raider Level Editor Font support
+## Configuration file
 
-OpenRaider can read Font.pc files used by the TRLE. If the fonts glyph positions match the TR4 defaults, only a Font.pc file is required. If the positions differ, you also need a [Leikkuri/Cutter](http://trep.trlevel.de/en/downloads.html) preset file (`.lps`).
+OpenRaider will try to load `~/.OpenRaider/OpenRaider.ini` or, if it doesn’t exist, `OpenRaider.ini` from the current working directory.
 
-TRLE Font support will automatically be built and used when selecting a font in your config file ending with `.pc`.
+Every line in this (text) file will be executed as an in-game console command. The # character marks the beginning of a comment until the next new-line.
 
-If a `.lps` is required, give it the same name as your font file.
+Use the in-game console help for more informations about available commands and their usage.
 
-I’ve made [a small writeup on my website](http://xythobuz.de/2014_06_14_trle_font.html) about this.
+## Default Key Bindings
 
-### Wireframe mode colors
+| Key                | Action                |
+| ------------------:|:--------------------- |
+| <Esc>        | Toggle menu           |
+| q                  | Toggle debug UI       |
+| <back quote> | Toggle console        |
+| w                  | Move forward          |
+| s                  | Move back             |
+| a                  | Move left             |
+| d                  | Move right            |
+| <space>      | Jump                  |
+| <left ctrl>  | crouch                |
+| Mouse              | Turn                  |
+| MouseBtn Left      | Shoot/Use             |
+| MouseBtn Right     | Holster/Equip weapons |
 
-* Red (thick) lines are portal outlines
-* Red (thin) lines are triangle room polygons
-* Black lines are quadralateral room polygons
-* White meshes are entities
-* Blue meshes are sprites
-* Yellow meshes are room models
-* Green lines with red endpoints are room bboxes
-* Pink dots are visibility checks
+If SDL2 is used, the first controller connected at the start of OpenRaider can be used as well, if its type is known to SDL2. The button-mapping is not yet changeable, however.
 
 ## License
 
-OpenRaider is based on code, specs, and algorithms from:
+The original OpenRaider is based on code, specs, and algorithms from:
 
 * GooseEgg/Freyja 3d Modelers by Mongoose
 * TR Rosetta Stone spec sheet by Anonymous
@@ -164,7 +93,7 @@ OpenRaider is based on code, specs, and algorithms from:
 
 All code should be GPLed, unless otherwise noted.
 
-Forked in December 2013 by xythobuz.
+Forked/Rewritten in December 2013 by Thomas Buck (xythobuz@xythobuz.de).
 
 The included example Font, [Droid Sans Mono](http://www.droidfonts.com/licensing/), was created by Steve Matteson and is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).
 
@@ -181,11 +110,7 @@ There are some included cmake scripts:
 
 See the respective files in `cmake` for their licensing.
 
-* Copyright 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>, Iowa State University, Distributed under the Boost Software License.
-* Copyright 2003-2009 Kitware, Inc.
-* Eric Wing
-
-The [clibs/commander](https://github.com/clibs/commander) dependency is Copyright (c) 2012 TJ Holowaychuk (tj@vision-media.ca) and licensed under the [MIT License](http://opensource.org/licenses/MIT).
+The included [clibs/commander](https://github.com/clibs/commander) lib is Copyright (c) 2012 TJ Holowaychuk (tj@vision-media.ca) and licensed under the [MIT License](http://opensource.org/licenses/MIT).
 
 The included GUI lib, [imgui](https://github.com/ocornut/imgui/) is Copyright (c) 2014 Omar Cornut. See src/deps/imgui/LICENSE for more informations about the MIT license used. 
 

include/Camera.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Camera.h
- * \brief Camera class
+ * \brief Camera, View Frustum
  *
  * \author xythobuz
  */

include/Console.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Console.h
- * \brief Console class
+ * \brief Console Window
  *
  * \author xythobuz
  */

include/Entity.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Entity.h
- * \brief World Entities
+ * \brief Things in the World
  *
  * \author xythobuz
  */

include/Game.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Game.h
- * \brief Game abstraction
+ * \brief Gameplay Handler
  *
  * \author xythobuz
  */

include/Log.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Log.h
- * \brief Log
+ * \brief Global Logging Utility
  *
  * \author xythobuz
  */

include/Mesh.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Mesh.h
- * \brief OpenGL Mesh
+ * \brief Textured/Colored Mesh
  *
  * \author xythobuz
  */

include/Render.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Render.h
- * \brief OpenRaider Renderer class
+ * \brief World Renderer
  *
  * \author Mongoose
  * \author xythobuz
@@ -43,7 +43,7 @@ class Render {
     static bool getDisplayViewFrustum() { return displayViewFrustum; }
 
   private:
-    static void buildRoomList(int room = -2);
+    static void buildRoomList(int room = -2, int budget = 10);
 
     static RenderMode mode;
     static std::vector<Room*> roomList;

include/Room.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Room.h
- * \brief World Room Mesh
+ * \brief Room in World
  *
  * \author xythobuz
  */

include/RoomData.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/RoomData.h
- * \brief World Room Mesh
+ * \brief Auxiliary Room classes
  *
  * \author xythobuz
  */

include/RoomMesh.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/RoomMesh.h
- * \brief World Room Mesh
+ * \brief Room Mesh Geometry
  *
  * \author xythobuz
  */

include/RunTime.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/RunTime.h
- * \brief run time configuration storage
+ * \brief Runtime Configuration Storage
  *
  * \author xythobuz
  */

include/Script.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Script.h
- * \brief Game script loader
+ * \brief Tomb Raider 2/3 Script Loader
  *
  * \author xythobuz
  */

include/SkeletalModel.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/SkeletalModel.h
- * \brief This is the factored out skeletal model class
+ * \brief Moveable Mesh Geometry
  *
  * \author Mongoose
  * \author xythobuz

include/SoundManager.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/SoundManager.h
- * \brief This is the audio manager Header
+ * \brief Sound Source Manager
  *
  * \author xythobuz
  */

include/Sprite.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Sprite.h
- * \brief World Sprite
+ * \brief 2D Billboard Collection
  *
  * \author xythobuz
  */

include/TextureManager.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/TextureManager.h
- * \brief Texture registry
+ * \brief Texture Registry
  *
  * \author Mongoose
  * \author xythobuz

include/UI.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/UI.h
- * \brief Abstract UI interface
+ * \brief UI/Event Manager
  *
  * \author xythobuz
  */

include/World.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/World.h
- * \brief The game world (model)
+ * \brief World Model
  *
  * \author Mongoose
  * \author xythobuz

include/commands/Command.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/commands/Command.h
- * \brief Command interface
+ * \brief Commands
  *
  * \author xythobuz
  */

include/commands/CommandBind.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/commands/CommandBind.h
- * \brief Bind Command interface
+ * \brief Bind Command
  *
  * \author xythobuz
  */

include/commands/CommandEngine.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/commands/CommandEngine.h
- * \brief Engine Command interface
+ * \brief Engine Commands
  *
  * \author xythobuz
  */

include/commands/CommandSet.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/commands/CommandSet.h
- * \brief Set Command interface
+ * \brief Get/Set Commands
  *
  * \author xythobuz
  */

include/games/TombRaider1.h

@@ -1,673 +0,0 @@
-/*!
- * \file include/games/TombRaider1.h
- * \brief Tomb Raider 1 items and states.
- *
- * Based on TR Rosetta Stone
- *
- * \author Mongoose
- * \author xythobuz
- */
-#ifndef _TOMBRAIDER1_H_
-#define _TOMBRAIDER1_H_
-
-/*!
- * \brief Tomb Raider 1 items and states
- */
-class TombRaider1 {
-  public:
-
-    /*!
-     * \brief States of a Wolf (Item 7)
-     */
-    enum WolfStates {
-        WolfState_Walking       = 1,
-        WolfState_Running       = 2,
-        WolfState_Jumping       = 3,
-        WolfState_Stalking      = 5,
-        WolfState_JumpingAttack = 6,
-        WolfState_Attacking     = 7,
-        WolfState_Lying         = 8,  //!< Lying down
-        WolfState_Getting       = 9,  //!< Getting ready to strike
-        WolfState_RunningJump   = 10,
-        WolfState_Dying         = 11,
-        WolfState_Biting        = 12
-    };
-
-    /*!
-     * \brief States of a Bear (Item 8)
-     */
-    enum BearStates {
-        BearState_Walking       = 0, //!< Walking on all fours
-        BearState_Getting       = 1, //!< Getting back to all fours
-        BearState_WalkingHind   = 2, //!< Walking on hind legs
-        BearState_Running       = 3, //!< Running on all fours
-        BearState_Rearing       = 4, //!< Rearing up on hind legs
-        BearState_Growling      = 5, //!< ?
-        BearState_RunningAttack = 6, //!< Running and attacking
-        BearState_Standing      = 7, //!< Standing on hind legs
-        BearState_Biting        = 8,
-        BearState_Dying         = 9
-    };
-
-    /*!
-     * \brief States of a Bat (Item 9)
-     */
-    enum BatStates {
-        BatState_Starting = 1, //!< Starting to fly
-        BatState_Flying   = 2, //!< Flying straight
-        BatState_Biting   = 3,
-        BatState_Circling = 4,
-        BatState_Dying    = 5
-    };
-
-    /*!
-     * \brief States of a Crocodile on land (Item 10)
-     */
-    enum CrocodileLandStates {
-        CrocodileLandState_Stationary = 1,
-        CrocodileLandState_Walking1   = 2,
-        CrocodileLandState_Walking2   = 3,
-        CrocodileLandState_Turning    = 4,
-        CrocodileLandState_Biting     = 5,
-        CrocodileLandState_Dying      = 7
-    };
-
-    /*!
-     * \brief States of a Crocodile in water (Item 11)
-     */
-    enum CrocodileWaterStates {
-        CrocodileWaterState_Swimming = 1,
-        CrocodileWaterState_Biting   = 2,
-        CrocodileWaterState_Dying    = 3
-    };
-
-    /*!
-     * \brief States of a Lion (Male & Female) and a Panther (Items 12, 13, 14)
-     */
-    enum LionStates {
-        LionState_Standing = 1,
-        LionState_Walking  = 2,
-        LionState_Leaping  = 3,
-        LionState_LeapBite = 4,
-        LionState_Dying    = 5,
-        LionState_Biting1  = 6,
-        LionState_Biting2  = 7
-    };
-
-    /*!
-     * \brief States of a Gorilla (Item 15)
-     */
-    enum GorillaStates {
-        GorillaState_Standing = 1,  //!< Standing on all fours
-        GorillaState_Running  = 3,  //!< Running on all fours
-        GorillaState_Walking  = 4,  //!< Walking on legs (attacking?)
-        GorillaState_Dying    = 5,
-        GorillaState_Thumping = 6,  //!< Thumping on chest
-        GorillaState_Waving   = 7,  //!< Waving arms
-        GorillaState_TurningL = 8,  //!< Turning leftward?
-        GorillaState_TurningR = 9,  //!< Turning rightward?
-        GorillaState_Jumping  = 10, //!< Jumping up and waving arms
-        GorillaState_Climbing = 11
-    };
-
-    /*!
-     * \brief States of a Giant Rat on land (Item 16)
-     */
-    enum GiantRatLandStates {
-        GiantRatLandState_Standing  = 1,
-        GiantRatLandState_JumpBite  = 2,
-        GiantRatLandState_Running   = 3,
-        GiantRatLandState_Biting    = 4,
-        GiantRatLandState_Dying     = 5,
-        GiantRatLandState_RearingUp = 6
-    };
-
-    /*!
-     * \brief States of a Giant Rat in the water (Item 17)
-     */
-    enum GiantRatWaterStates {
-        GiantRatWaterState_Swimming = 1,
-        GiantRatWaterState_Biting   = 2,
-        GiantRatWaterState_Dying    = 3
-    };
-
-    /*!
-     * \brief States of a Tyrannosaur (Item 18)
-     */
-    enum TyrannosaurStates {
-        TyrannosaurState_Standing  = 1,
-        TyrannosaurState_Walking   = 2,
-        TyrannosaurState_Running   = 3,
-        TyrannosaurState_Dying     = 5,
-        TyrannosaurState_Bellowing = 6,
-        TyrannosaurState_Biting    = 7,
-        TyrannosaurState_Shaking   = 8  //!< Shaking Head and Spitting Out
-    };
-
-    /*!
-     * \brief States of a Raptor (Item 19)
-     */
-    enum RaptorStates {
-        RaptorState_Dying     = 0,
-        RaptorState_Standing  = 1,
-        RaptorState_Walking   = 2,
-        RaptorState_Running   = 3,
-        RaptorState_JumpBite  = 4,
-        RaptorState_Bellowing = 6,
-        RaptorState_RunBellow = 7,
-        RaptorState_Biting    = 8
-    };
-
-    /*!
-     * \brief States of a Winged Mutant (Item 20)
-     */
-    enum WingedMutantStates {
-        WingedMutantState_Crouching = 1,
-        WingedMutantState_Walking   = 2,
-        WingedMutantState_Running   = 3,
-        WingedMutantState_Biting    = 4,
-        WingedMutantState_Looking   = 6,
-        WingedMutantState_Jumping   = 7,
-        WingedMutantState_Clawing   = 8,
-        WingedMutantState_Aiming    = 9,  //!< Aiming Right-Hand Gun
-        WingedMutantState_AimFire   = 10, //!< Aiming and Firing Left-Hand Gun
-        WingedMutantState_Firing    = 11, //!< Firing Right-Hand Gun
-        WingedMutantState_Standing  = 12,
-        WingedMutantState_Flying    = 13
-    };
-
-    /*!
-     * \brief States of a Centaur Mutant (Item 23)
-     */
-    enum CentaurMutantStates {
-        CentaurMutantState_Standing  = 1,
-        CentaurMutantState_Firing    = 2,
-        CentaurMutantState_Galloping = 3,
-        CentaurMutantState_Aiming    = 4,
-        CentaurMutantState_Dying     = 5,
-        CentaurMutantState_Rearing   = 6  //!<  Rearing up
-    };
-
-    /*!
-     * \brief States of a Mummy (Item 24)
-     */
-    enum MummyStates {
-        MummyState_Standing = 1,
-        MummyState_Falling  = 2  //!< Falling forward
-    };
-
-    /*!
-     * \brief States of Larson (Item 27)
-     */
-    enum LarsonStates {
-        LarsonState_Walking1    = 0,
-        LarsonState_StandingGun = 1,
-        LarsonState_Walking2    = 2,
-        LarsonState_Running     = 3,
-        LarsonState_Aiming      = 4,
-        LarsonState_Injured     = 5, //!< Injured by gunshot / Dying
-        LarsonState_Standing    = 6,
-        LarsonState_Firing      = 7
-    };
-
-    /*!
-     * \brief States of Pierre (Item 28)
-     */
-    enum PierreStates {
-        PierreState_Standing   = 1,
-        PierreState_Walking    = 2,
-        PierreState_Running    = 3,
-        PierreState_Aiming     = 4,
-        PierreState_Dying      = 5,
-        PierreState_Holstering = 6,
-        PierreState_Firing     = 7
-    };
-
-    /*!
-     * \brief States of the Skateboard (Item 29)
-     */
-    enum SkateboardStates {
-        SkateboardState_BeingTurned = 0,
-        SkateboardState_Stationary1 = 1,
-        SkateboardState_Stationary2 = 2,
-        SkateboardState_Stationary3 = 3,
-        SkateboardState_Stationary4 = 4
-    };
-
-    /*!
-     * \brief States of the Skateboard Kid (Item 30)
-     */
-    enum SkateboardKidStates {
-        SkateboardKidState_Turning = 0, //!< Turning and Aiming?
-        SkateboardKidState_Firing1 = 1,
-        SkateboardKidState_Skating = 2,
-        SkateboardKidState_Aiming  = 3,
-        SkateboardKidState_Firing2 = 4,
-        SkateboardKidState_Dying   = 5
-    };
-
-    /*!
-     * \brief States of the Cowboy (Item 31)
-     */
-    enum CowboyStates {
-        CowboyState_Aiming1 = 1,
-        CowboyState_Walking = 2,
-        CowboyState_Running = 3,
-        CowboyState_Aiming2 = 4,
-        CowboyState_Dying   = 5,
-        CowboyState_Firing  = 6
-    };
-
-    /*!
-     * \brief States of Mr. T (Item 32)
-     */
-    enum MrTStates {
-        MrTState_Dying    = 0,
-        MrTState_Standing = 1,
-        MrTState_Walking  = 2,
-        MrTState_Running  = 3,
-        MrTState_Aiming   = 4,
-        MrTState_Firing   = 6
-    };
-
-    /*!
-     * \brief States of Winged Natla (Item 33)
-     */
-    enum WingedNatlaStates {
-        WingedNatlaState_Standing1 = 1,
-        WingedNatlaState_Flying    = 2,
-        WingedNatlaState_Running   = 3,
-        WingedNatlaState_Aiming    = 4, //!< Aiming and Firing
-        WingedNatlaState_Dying1    = 5, //!< "Dying" the first time
-        WingedNatlaState_Spinning  = 7, //!< Spinning around in air
-        WingedNatlaState_Standing2 = 8,
-        WingedNatlaState_Dying2    = 9  //!< Dying for real
-    };
-
-    /*!
-     * \brief States of the Giant Mutant (Item 34)
-     */
-    enum GiantMutantStates {
-        GiantMutantState_Dying         = 0,
-        GiantMutantState_Sitting       = 1, //!< Sitting on floor
-        GiantMutantState_Pulling       = 2, //!< Pulling self forward
-        GiantMutantState_SlappingRight = 4, //!< Slapping with right hand
-        GiantMutantState_SlappingBoth  = 5, //!< Slapping with both hands
-        GiantMutantState_MakingWave    = 6, //!< Making big wave with right hand
-        GiantMutantState_Dropping      = 8, //!< Dropping to floor after hatching
-        GiantMutantState_RaisingArms   = 9,
-        GiantMutantState_Shaking       = 11 //!< Shaking victim with right hand
-    };
-
-    /*!
-     * \brief States of a piece of Collapsible Floor (Item 35)
-     */
-    enum CollapsibleFloorStates {
-        CollapsibleFloorState_Stationary = 0,
-        CollapsibleFloorState_Shaking    = 1,
-        CollapsibleFloorState_Falling    = 2,
-        CollapsibleFloorState_Settling   = 3  //!< Settling down
-    };
-
-    /*!
-     * \brief States of a Swinging Blade (Item 36)
-     */
-    enum SwingingBladeStates {
-        SwingingBladeState_Stationary = 0,
-        SwingingBladeState_Swinging   = 2
-    };
-
-    /*!
-     * \brief States of a Boulder (Item 38)
-     */
-    enum BoulderStates {
-        BoulderState_Stationary = 0,
-        BoulderState_Rolling    = 1
-    };
-
-    /*!
-     * \brief States of a Dart Gun (Item 40)
-     */
-    enum DartGunStates {
-        DartGunState_Idle   = 0, //!< ?
-        DartGunState_Firing = 1  //!< ?
-    };
-
-    /*!
-     * \brief States of a Door opening upwards (Item 41)
-     */
-    enum DoorUpwardStates {
-        DoorUpwardState_Upward = 0,
-        DoorUpwardState_OnSide = 1
-    };
-
-    /*!
-     * \brief States of a Slamming Door (Item 42)
-     */
-    enum SlammingDoorStates {
-        SlammingDoorState_Open   = 0,
-        SlammingDoorState_Closed = 1
-    };
-
-    /*!
-     * \brief States of the Handle of Thors Hammer (Item 44)
-     */
-    enum ThorHammerHandleStates {
-        ThorHammerHandleState_Stationary = 0, //!< Stationary in up position
-        ThorHammerHandleState_Moving1    = 1, //!< Moving down a little and returning
-        ThorHammerHandleState_Moving2    = 2, //!< Moving down all the way
-        ThorHammerHandleState_Stopped    = 3  //!< Stopped at down position
-    };
-
-    /*!
-     * \brief States of the Block of Thors Hammer (Item 45)
-     */
-    enum ThorHammerBlockStates {
-        ThorHammerBlockState_Stationary = 0,
-        ThorHammerBlockState_Moving1    = 1, //!< Moving down a little and returning
-        ThorHammerBlockState_Moving2    = 2  //!< Moving down all the way
-    };
-
-    /*!
-     * \brief States of a Metal Rod (Item 47)
-     */
-    enum MetalRodStates {
-        MetalRodState_Stationary = 0,
-        MetalRodState_Moving     = 1
-    };
-
-    /*!
-     * \brief States of a Pushable Cubical (Item 48 - 51)
-     */
-    enum PushableStates {
-        PushableState_Stationary = 0,
-        PushableState_Pulled     = 1, //!< ?
-        PushableState_Pushed     = 2  //!< ?
-    };
-
-    /*!
-     * \brief States of a Movable Tall Block (Item 52)
-     */
-    enum MovableTallBlockStates {
-        MovableTallBlockState_Stationary     = 0,
-        MovableTallBlockState_MovingForward  = 1, //!< ?
-        MovableTallBlockState_MovingBackward = 2  //!< ?
-    };
-
-    /*!
-     * \brief States of Falling Pieces (Item 53)
-     */
-    enum FallingPiecesStates {
-        FallingPiecesState_Stationary = 0,
-        FallingPiecesState_Falling    = 1,
-        FallingPiecesState_Settling   = 2  //!< Settling down
-    };
-
-    /*!
-     * \brief States of a Switch (Item 55, 56)
-     */
-    enum SwitchStates {
-        SwitchState_Off = 0,
-        SwitchState_On  = 1  //!< States may be reversed
-    };
-
-    /*!
-     * \brief States of a Door (Item 57 - 66)
-     */
-    enum DoorStates {
-        DoorState_Closed = 0,
-        DoorState_Open   = 1
-    };
-
-    /*!
-     * \brief States of a Cog (Item 74 - 76)
-     */
-    enum CogStates {
-        CogState_Stationary = 0,
-        CogState_Turning    = 1
-    };
-
-    /*!
-     * \brief States of a Shack (Item 162)
-     */
-    enum ShackStates {
-        ShackState_StartingPosition = 0,
-        ShackState_DroppingFirst    = 1, //!< Dropping after first fuse
-        ShackState_DroppingSecond   = 2, //!< Dropping after second fuse
-        ShackState_DroppingThird    = 3, //!< Dropping to ground after third fuse
-        ShackState_OnGround         = 4
-    };
-
-    /*!
-     * \brief States of a Mutant Egg & Holder (Item 163 & 181)
-     */
-    enum MutantEggStates {
-        MutantEggState_Starting = 0,
-        MutantEggState_Hatching = 1  //!< Is the fragmenting hardcoded?
-    };
-
-    /*!
-     * \brief States of a Motorboat (Item 182)
-     */
-    enum MotorboatStates {
-        MotorboatState_StationaryInitial = 1,
-        MotorboatState_Moving            = 2,
-        MotorboatState_StationaryFinal   = 3
-    };
-
-    /*!
-     * \brief Items & IDs in Tomb Raider 1
-     */
-    enum Items {
-        Lara             = 0,
-        PistolAnimation  = 1,
-        ShotgunAnimation = 2,
-        MagnumAnimation  = 3,
-        LaraAlternate    = 4,  //!< Lara's home appearance, wounded, or turned to gold
-        UziAnimation     = 5,
-        LaraMutant       = 6,
-        Wolf             = 7,
-        Bear             = 8,
-        Bat              = 9,
-        CrocodileLand    = 10,
-        CrocodileWater   = 11,
-        LionMale         = 12,
-        LionFemale       = 13, //!< Same states as Male Lion
-        Panther          = 14, //!< Same states as Male and Female Lion
-        Gorilla          = 15,
-        GiantRatLand     = 16,
-        GiantRatWater    = 17,
-        Tyrannosaur      = 18,
-        Raptor           = 19,
-        WingedMutant     = 20, //!< Also winged mummy (unused)
-        LaraHips1        = 21,
-        LaraHips2        = 22,
-        CentaurMutant    = 23,
-        Mummy            = 24,
-
-        Larson           = 27,
-        Pierre           = 28,
-        Skateboard       = 29,
-        SkateboardKid    = 30,
-        Cowboy           = 31,
-        MrT              = 32,
-        WingedNatla      = 33, //!< Actually Natla with a winged mutant
-        GiantMutant      = 34,
-        CollapsibleFloor = 35,
-        SwingingBlade    = 36,
-        Spikes           = 37,
-        Boulder          = 38,
-        Dart             = 39,
-        DartGun          = 40,
-        DoorUpward       = 41,
-        SlammingDoor     = 42,
-        SwordOfDamocles1 = 43,
-        ThorHammerHandle = 44,
-        ThorHammerBlock  = 45,
-        HangingBall      = 46, //!< Hanging ball? Some kind of box?
-        MetalRod         = 47, //!< Metal rod? / Powered mining cart
-        PushableCubical1 = 48,
-        PushableCubical2 = 49,
-        PushableCubical3 = 50,
-        PushableCubical4 = 51,
-        MovableTallBlock = 52,
-        FallingPieces    = 53,
-        SwordOfDamocles2 = 54,
-        AboveWaterSwitch = 55,
-        UnderWaterSwitch = 56,
-        Door1            = 57,
-        Door2            = 58,
-        Door3            = 59,
-        Door4            = 60,
-        Door5            = 61,
-        Door6            = 62,
-        Door7            = 63,
-        Door8            = 64,
-        Trapdoor1        = 65, //!< Uses DoorStates
-        Trapdoor2        = 66, //!< Uses DoorStates
-
-        BridgeFlat       = 68,
-        BridgeSlope1     = 69,
-        BridgeSlope2     = 70,
-        PassportOpen     = 71, //!< Passport opening up
-        Compass          = 72,
-
-        Cogs1            = 74, //!< animated
-        Cogs2            = 75, //!< animated
-        Cogs3            = 76, //!< animated
-        CS_Lara          = 77, //!< Lara / Scion holder in Cut Scene
-        CS_Larson        = 78, //!< Larson / Natla / Scion holder in Cut Scene
-        CS_LarsonGun     = 79, //!< Larsons gun / Scion / Natla in Cut Scene
-        CS_Scion         = 80, //!< Scion in Cut Scene
-        PassportClosed   = 81, //!< Passport closed
-        N                = 82, //!< N-thingy, Playstation memory card?
-        SaveCrystal      = 83,
-        _Pistols         = 84,
-        _Shotgun         = 85,
-        _Magnums         = 86,
-        _Uzis            = 87,
-        _PistolAmmo      = 88, //!< ?
-        _ShotgunAmmo     = 89,
-        _MagnumAmmo      = 90,
-        _UziAmmo         = 91,
-
-        _SmallMedipack   = 93,
-        _LargeMedipack   = 94,
-        Sunglasses       = 95,
-        Cassette         = 96, // Cassette player and headphones
-        DirectionKeys    = 97,
-
-        Pistol           = 99,
-        Shotgun          = 100,
-        Magnum           = 101,
-        Uzi              = 102,
-        PistolAmmo       = 103, //!< ?
-        ShotgunAmmo      = 104,
-        MagnumAmmo       = 105,
-        UziAmmo          = 106,
-
-        SmallMedipack    = 108,
-        LargeMedipack    = 109,
-        _Puzzle1         = 110,
-        _Puzzle2         = 111,
-        _Puzzle3         = 112,
-        _Puzzle4         = 113,
-        Puzzle1          = 114,
-        Puzzle2          = 115,
-        Puzzle3          = 116,
-        Puzzle4          = 117,
-        Slot1Empty       = 118,
-        Slot2Empty       = 119,
-        Slot3Empty       = 120,
-        Slot4Empty       = 121,
-        Slot1Full        = 122,
-        Slot2Full        = 123,
-        Slot3Full        = 124,
-        Slot4Full        = 125,
-        _Pickup1         = 126,
-        Pickup1          = 127,
-        LaraHips3        = 128,
-        _Key1            = 129,
-        _Key2            = 130,
-        _Key3            = 131,
-        _Key4            = 132,
-        Key1             = 133,
-        Key2             = 134,
-        Key3             = 135,
-        Key4             = 136,
-        Lock1            = 137,
-        Lock2            = 138,
-        Lock3            = 139,
-        Lock4            = 140,
-
-        _ScionPiece      = 143,
-
-        CompleteScion    = 146,
-        ScionHolder      = 147,
-
-        ScionPiece       = 150,
-        _Flare           = 151, //!< Flare(?) / Explosion
-
-        _Splash          = 153,
-
-        _Bubbles1        = 155,
-        _Bubbles2        = 156,
-
-        _BloodSplatter   = 158,
-
-        _FlyingDisk      = 160,
-        CentaurStatue    = 161,
-        Shack            = 162, //!< Suspended from wire rope
-        MutantEggNormal  = 163, //!< Mutant Egg and Holder (Normal)
-        _BulletHit       = 164,
-        _Sparkle         = 165,
-        Gunflare1        = 166,
-
-        LaraHips4        = 169,
-        LaraHips5        = 170,
-
-        MutantBullet     = 172,
-        MutantGrenade    = 173,
-
-        _Splatter        = 176,
-        LaraHips6        = 177,
-        _Fire            = 178,
-        LaraHips7        = 179,
-        FlowingLava      = 180, //!< Flowing Atlantean Lava
-        MutantEggBig     = 181, //!< Mutant Egg and Holder (Big)
-        Motorboat        = 182,
-        LaraHips8        = 183,
-
-        ShrinkingWedge   = 189, //!< ?
-        _StandardSymbols = 190,
-        _Plant1          = 191,
-        _Plant2          = 192,
-        _Plant3          = 193,
-        _Plant4          = 194,
-        _Plant5          = 195,
-
-        _Bag1            = 200,
-
-        _Bag2            = 204,
-
-        Gunflare2        = 207,
-
-        _Rock1           = 212,
-        _Rock2           = 213,
-        _Rock3           = 214,
-        _Bag3            = 215,
-        _Pottery1        = 216,
-        _Pottery2        = 217,
-
-        _PaintedPot      = 231,
-
-        _IncaMummy       = 233,
-
-        _Pottery3        = 236,
-        _Pottery4        = 237,
-        _Pottery5        = 238,
-        _Pottery6        = 239
-    };
-};
-
-#endif

include/global.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/global.h
- * \brief Global typedefs
+ * \brief Included everywhere
  *
  * \author xythobuz
  */
@@ -75,15 +75,15 @@ typedef enum {
 #include <GL/wglew.h>
 #pragma comment(lib, "glew32.lib")
 #else // _WIN32
-//! \todo gl3 header?
+//! \fixme gl3 header?
 #include <GL/gl.h>
 #include <GL/glext.h>
 #endif // _WIN32
 #endif // __APPLE__
 
-/*! \todo Is there a better way to handle this?
+/*! \fixme Is there a better way to handle this?
  * We wan't to use our own assert(). Unfortunately, glm includes
- * <cassert> in its headers. So we need to define NDEBUG here.
+ * cassert in its headers. So we need to define NDEBUG here.
  * To avoid a conflict, our flag is now called NODEBUG instead.
  */
 #define NDEBUG

include/system/Font.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/Font.h
- * \brief Font interface
+ * \brief Font Interface
  *
  * \author xythobuz
  */

include/system/FontImGui.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/FontImGui.h
- * \brief Default Font implementation
+ * \brief Default Font Implementation
  *
  * \author xythobuz
  */

include/system/FontTTF.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/FontTTF.h
- * \brief TrueType Font implementation
+ * \brief TrueType Font Implementation
  *
  * \author xythobuz
  */

include/system/Shader.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/Shader.h
- * \brief OpenGL Shader implementation
+ * \brief OpenGL Shader Implementation
  *
  * \author xythobuz
  */

include/system/Sound.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/Sound.h
- * \brief This is the audio manager Header
+ * \brief Sound Interface
  *
  * \author xythobuz
  */

include/system/SoundAL.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/SoundAL.h
- * \brief This is the OpenAL audio manager Header
+ * \brief OpenAL Sound Implementation
  *
  * \author xythobuz
  */

include/system/Window.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/Window.h
- * \brief Windowing interface
+ * \brief Windowing Interface
  *
  * \author xythobuz
  */

include/system/WindowGLFW.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/WindowGLFW.h
- * \brief GLFW windowing implementation
+ * \brief GLFW Windowing Implementation
  *
  * \author xythobuz
  */

include/system/WindowSDL.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/system/WindowSDL.h
- * \brief SDL windowing implementation
+ * \brief SDL2 Windowing Implementation
  *
  * \author xythobuz
  */

include/utils/Folder.h

@@ -1,5 +1,5 @@
 /*!
- * \file include/utils/FileSystem.h
+ * \file include/utils/Folder.h
  * \brief Recursive file-system walking utilities
  *
  * \author xythobuz

src/Camera.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Camera.cpp
- * \brief Camera class
+ * \brief Camera, View Frustum
  *
  * \author Mongoose
  * \author xythobuz

src/Console.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Console.cpp
- * \brief Console class
+ * \brief Console Window
  *
  * \author xythobuz
  */

src/Entity.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Entity.cpp
- * \brief World Entities
+ * \brief Things in the World
  *
  * \author xythobuz
  */

src/Game.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Game.cpp
- * \brief Game abstraction
+ * \brief Gameplay Handler
  *
  * \author xythobuz
  */

src/Log.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Log.cpp
- * \brief Log
+ * \brief Global Logging Utility
  *
  * \author xythobuz
  */

src/Menu.cpp

@@ -78,7 +78,7 @@ void Menu::shutdown() {
 
     scripts.clear();
     paths.clear();
-    images.clear(); //! \TODO free texture slots
+    images.clear(); //! \fixme free texture slots
 }
 
 void Menu::display() {

src/Mesh.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Mesh.cpp
- * \brief OpenGL Mesh
+ * \brief Textured/Colored Mesh
  *
  * \author xythobuz
  */

src/Render.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Render.cpp
- * \brief OpenRaider Renderer class
+ * \brief World Renderer
  *
  * \author Mongoose
  * \author xythobuz
@@ -47,8 +47,8 @@ void Render::display() {
 
     if (Camera::update()) {
         int r = Camera::getRoom();
+        clearRoomList();
         if (r < 0) {
-            clearRoomList();
             buildRoomList();
         } else {
             buildRoomList(r);
@@ -78,16 +78,16 @@ void Render::display() {
     }
 }
 
-void Render::buildRoomList(int room) {
+void Render::buildRoomList(int room, int budget) {
     if (room < -1) {
         // Check if the camera currently is in a room...
         for (int i = 0; i < getWorld().sizeRoom(); i++) {
             if (getWorld().getRoom(i).getBoundingBox().inBox(Camera::getPosition())) {
-                buildRoomList(i);
+                buildRoomList(i, budget);
                 return;
             }
         }
-        buildRoomList(-1);
+        buildRoomList(-1, budget);
     } else if (room == -1) {
         // Check visibility for all rooms!
         for (int i = 0; i < getWorld().sizeRoom(); i++) {
@@ -96,7 +96,7 @@ void Render::buildRoomList(int room) {
             }
         }
     } else {
-        // Check visibility of room and connected rooms, recursively?
+        // Check visibility of room and connected rooms, recursively
         if (Camera::boxInFrustum(getWorld().getRoom(room).getBoundingBox())) {
             roomList.push_back(&getWorld().getRoom(room));
             for (int i = 0; i < getWorld().getRoom(room).sizePortals(); i++) {
@@ -108,8 +108,11 @@ void Render::buildRoomList(int room) {
                         break;
                     }
                 }
-                if (!found)
-                    buildRoomList(r);
+                if (!found) {
+                    if (budget > 0) {
+                        buildRoomList(r, --budget);
+                    }
+                }
             }
         }
     }

src/Room.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Room.cpp
- * \brief World Room Mesh
+ * \brief Room in World
  *
  * \author xythobuz
  */

src/RoomData.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/RoomData.cpp
- * \brief World Room Mesh
+ * \brief Auxiliary Room classes
  *
  * \author xythobuz
  */

src/RoomMesh.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/RoomMesh.cpp
- * \brief World Room Mesh
+ * \brief Room Mesh Geometry
  *
  * \author xythobuz
  */

src/RunTime.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/RunTime.cpp
- * \brief run time configuration storage
+ * \brief Runtime Configuration Storage
  *
  * \author xythobuz
  */

src/Script.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Script.cpp
- * \brief Game script loader
+ * \brief Tomb Raider 2/3 Script Loader
  *
  * \author xythobuz
  */

src/SkeletalModel.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/SkeletalModel.cpp
- * \brief This is the factored out skeletal model class
+ * \brief Moveable Mesh Geometry
  *
  * \author Mongoose
  * \author xythobuz

src/SoundManager.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/SoundManager.cpp
- * \brief This is the audio manager Implementation
+ * \brief Sound Source Manager
  *
  * \author xythobuz
  */

src/Sprite.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/Sprite.cpp
- * \brief World Sprite
+ * \brief 2D Billboard Collection
  *
  * \author xythobuz
  */

src/TextureManager.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/TextureManager.cpp
- * \brief Texture registry
+ * \brief Texture Registry
  *
  * \author Mongoose
  * \author xythobuz
@@ -210,7 +210,7 @@ int TextureManager::numTextures(TextureStorage s) {
 
 void TextureManager::bindTextureId(unsigned int n, TextureStorage s, unsigned int unit) {
     assertLessThan(n, getIds(s).size());
-    assertLessThan(unit, 80); //! \todo Query GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS
+    assertLessThan(unit, 80); //! \fixme Query GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS
 
     glActiveTexture(GL_TEXTURE0 + unit);
     glBindTexture(GL_TEXTURE_2D, getIds(s).at(n));

src/UI.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/UI.cpp
- * \brief UI interface manager
+ * \brief UI/Event Manager
  *
  * \author xythobuz
  */
@@ -83,7 +83,7 @@ int UI::initialize() {
     io.ImeSetInputScreenPosFn = Window::inputPositionCallback;
 
     // Load font texture
-    //! \TODO allow loading other TTF fonts
+    //! \fixme allow loading other TTF fonts
     unsigned char* pixels;
     int width, height;
     io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);

src/World.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/World.cpp
- * \brief The game world (model)
+ * \brief World Model
  *
  * \author Mongoose
  */

src/commands/CommandBind.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/commands/CommandBind.cpp
- * \brief Bind command
+ * \brief Bind Command
  *
  * \author xythobuz
  */

src/commands/CommandEngine.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/commands/CommandEngine.cpp
- * \brief Engine commands
+ * \brief Engine Commands
  *
  * \author xythobuz
  */

src/commands/CommandSet.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/commands/CommandSet.cpp
- * \brief Set command
+ * \brief Get/Set Commands
  *
  * \author xythobuz
  */

src/loader/LoaderTR1.cpp

@@ -127,7 +127,7 @@ void LoaderTR1::loadRoomStaticMeshes(std::vector<StaticModel*>& staticModels) {
         uint16_t rotation = file.readU16();
 
         // Constant lighting, 0xFFFF means use mesh lighting
-        //! \todo Use static mesh lighting information
+        //! \fixme Use static mesh lighting information
         uint16_t intensity1 = file.readU16();
 
         // Which StaticMesh item to draw

src/loader/LoaderTR2.cpp

@@ -223,7 +223,7 @@ void LoaderTR2::loadRoomStaticMeshes(std::vector<StaticModel*>& staticModels) {
         uint16_t rotation = file.readU16();
 
         // Constant lighting, 0xFFFF means use mesh lighting
-        //! \todo Use static mesh lighting information
+        //! \fixme Use static mesh lighting information
         uint16_t intensity1 = file.readU16();
         uint16_t intensity2 = file.readU16();
 
@@ -381,7 +381,7 @@ void LoaderTR2::loadRooms() {
             int16_t yCorner4 = file.read16();
             int16_t zCorner4 = file.read16();
 
-            //! \fixme TODO translate vertices by room offset!
+            // TODO translate vertices by room offset!
 
             portals.push_back(new Portal(adjoiningRoom,
                                          glm::vec3(xNormal, yNormal, zNormal),

src/main.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/main.cpp
- * \brief Where main() is
+ * \brief Main Entry Point
  *
  * \author xythobuz
  */

src/system/Font.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/Font.cpp
- * \brief Font implementation
+ * \brief Font Interface
  *
  * \author xythobuz
  */

src/system/FontImGui.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/FontImGui.cpp
- * \brief Default Font implementation
+ * \brief Default Font Implementation
  *
  * \author xythobuz
  */

src/system/FontTTF.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/FontTTF.cpp
- * \brief TrueType Font implementation
+ * \brief TrueType Font Implementation
  *
  * \author xythobuz
  */
@@ -34,7 +34,7 @@ FontMapTTF::~FontMapTTF() {
     }
 
     if (texture > -1) {
-        //! \todo _Free_ the TextureManager buffer slot
+        //! \fixme Free the TextureManager buffer slot
     }
 }
 
@@ -267,7 +267,7 @@ int FontTTF::charIsMapped(int c) {
 
 int FontTTF::getQuad(int c, float* xpos, float* ypos, stbtt_aligned_quad* quad) {
     if (c < 0) {
-        //! \todo This has nothing to do with proper UTF8 support...
+        //! \fixme This has nothing to do with proper UTF8 support...
         c += 128;
     }
 

src/system/Shader.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/Shader.cpp
- * \brief OpenGL Shader implementation
+ * \brief OpenGL Shader Implementation
  *
  * \author xythobuz
  */
@@ -78,7 +78,7 @@ ShaderTexture::~ShaderTexture() {
     glDeleteRenderbuffers(1, &depth);
     glDeleteFramebuffers(1,  &framebuffer);
 
-    //! \TODO free texture slot
+    //! \fixme free texture slot
 }
 
 void ShaderTexture::clear() {

src/system/Sound.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/Sound.cpp
- * \brief This is the audio manager Implementation
+ * \brief Sound Interface
  *
  * \author xythobuz
  */

src/system/SoundAL.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/SoundAL.cpp
- * \brief This is the OpenAL audio manager Implementation
+ * \brief OpenAL Sound Implementation
  *
  * \author Mongoose
  * \author xythobuz

src/system/Window.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/Window.cpp
- * \brief windowing implementation
+ * \brief Windowing Interface
  *
  * \author xythobuz
  */

src/system/WindowGLFW.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/WindowGLFW.cpp
- * \brief GLFW windowing implementation
+ * \brief GLFW Windowing Implementation
  *
  * \author xythobuz
  */
@@ -93,7 +93,7 @@ void WindowGLFW::setSize(glm::i32vec2 s) {
 
 void WindowGLFW::setFullscreen(bool f) {
     fullscreen = f;
-    //! \todo GLFW does not support toggling fullscreen?!
+    //! \fixme GLFW does not support toggling fullscreen?!
 }
 
 void WindowGLFW::setMousegrab(bool g) {
@@ -166,7 +166,7 @@ void WindowGLFW::keyCallback(GLFWwindow* w, int key, int scancode, int action, i
     }
 
     if (textinput && (action != GLFW_RELEASE)) {
-        //! \todo GLFW does not support UTF8 text input?!
+        //! \fixme GLFW does not support UTF8 text input?!
         if ((key >= '0') && (key <= '9')) {
             char s[2] = { (char)key, '\0' };
             UI::handleText(s, false);

src/system/WindowSDL.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/system/WindowSDL.cpp
- * \brief SDL windowing implementation
+ * \brief SDL2 Windowing Implementation
  *
  * \author xythobuz
  */

src/utils/Folder.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file src/utils/Folder.cpp
- * \brief Recursive file-system walking utilities
+ * \brief File-system walking utilities
  *
  * \author xythobuz
  */

src/utils/FolderRecursive.cpp

@@ -1,5 +1,5 @@
 /*!
- * \file src/utils/Folder.cpp
+ * \file src/utils/FolderRecursive.cpp
  * \brief Recursive file-system walking utilities
  *
  * \author xythobuz

test/Script.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file test/Script.cpp
- * \brief Game script loader unit test
+ * \brief Tomb Raider Script Loader Unit Test
  *
  * \author xythobuz
  */

test/ScriptPayload.h

@@ -1,6 +1,6 @@
 /*!
  * \file test/ScriptPayload.h
- * \brief Game script loader unit test payload
+ * \brief Tomb Raider Script Loader Unit Test Payload
  *
  * \author xythobuz
  */

test/ScriptTest.h

@@ -1,6 +1,6 @@
 /*!
  * \file test/ScriptTest.h
- * \brief Game script loader unit test payload
+ * \brief Tomb Raider Script Loader Unit Test Header
  *
  * \author xythobuz
  */

test/binary.cpp

@@ -1,6 +1,6 @@
 /*!
  * \file test/binary.cpp
- * \brief Binary Unit Test
+ * \brief Binary File Reading Unit Test
  *
  * \author xythobuz
  */