Docs

.gitignore

@@ -3,3 +3,4 @@ build/*
 simulator/*
 docs/build/*
 docs/xml/*
+docs/html/*

docs/source/conf.py

@@ -58,4 +58,6 @@
 breathe_projects = { "codecharacterdocs": "../xml" }
 
 #Specify a default project:
-breathe_default_project = "codecharacterdocs"
+breathe_default_project = "codecharacterdocs"
+
+breathe_domain_by_extension = {"h" : "cpp" }

docs/source/constants.rst

@@ -0,0 +1,21 @@
+============
+Constants
+============
+
+Actor
+=======
+
+.. doxygenfile:: constants/actor.h
+    :project: codecharacterdocs
+
+Map
+=======
+
+.. doxygenfile:: constants/map.h
+    :project: codecharacterdocs
+
+Score
+=======
+
+.. doxygenfile:: constants/score_manager.h
+    :project: codecharacterdocs

docs/source/drivers.rst

@@ -0,0 +1,22 @@
+===========
+Drivers
+===========
+
+
+Shared Buffer
+================
+
+.. doxygenfile:: shared_buffer.h
+    :project: codecharacterdocs
+
+Shared Memory Main
+=====================
+
+.. doxygenfile:: shared_memory_main.h
+    :project: codecharacterdocs
+
+Shared Memory player
+======================
+
+.. doxygenfile:: shared_memory_player.h
+    :project: codecharacterdocs

docs/source/index.rst

@@ -10,19 +10,16 @@ Welcome to CodeCharacter's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-Docs
-====
+   constants
+   logger
+   physics
+   state
+   player_wrapper
+   drivers
 
-.. doxygenindex:: 
-.. doxygenstruct:: 
-.. doxygenfunction:: 
-.. doxygenenum:: 
-.. doxygentypedef:: 
-.. doxygenclass:: 
 
-Indices and tables
+
+Index
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/source/logger.rst

@@ -0,0 +1,27 @@
+============
+Logger
+============
+
+
+Namespace
+============
+
+Logger
+-----------
+
+.. doxygennamespace:: logger
+    :project: codecharacterdocs
+    :outline:
+
+ILogger
+============
+
+.. doxygenfile:: i_logger.h
+   :project: codecharacterdocs
+
+Logger
+============
+
+.. doxygenfile:: logger.h
+   :project: codecharacterdocs
+

docs/source/physics.rst

@@ -0,0 +1,10 @@
+==========
+Physics
+==========
+
+vector
+==========
+
+.. doxygenfile:: vector.hpp
+    :project: codecharacterdocs
+

docs/source/player_wrapper.rst

@@ -0,0 +1,28 @@
+================
+Player Wrapper
+================
+
+Namespace
+==========
+
+.. doxygennamespace:: player_wrapper
+    :project: codecharacterdocs
+    :outline:
+
+Transfer State
+================
+
+.. doxygenfile:: transfer_state.h
+    :project: codecharacterdocs
+
+IPlayerCode
+=============
+
+.. doxygenfile:: i_player_code.h
+    :project: codecharacterdocs
+
+Player Wrapper
+===============
+
+.. doxygenfile:: player_code_wrapper.h
+    :project: codecharacterdocs

docs/source/state.rst

@@ -0,0 +1,185 @@
+==========
+State
+==========
+
+
+Namespace
+==========
+
+.. doxygennamespace:: state
+    :project: codecharacterdocs
+    :outline:
+    :no-link:
+
+.. doxygenclass:: state::Bot
+        :project: codecharacterdocs
+
+.. doxygenclass:: state::Tower
+    :project: codecharacterdocs
+
+State
+-------
+
+.. doxygenfile:: state.h
+    :project: codecharacterdocs
+
+Interfaces
+============
+
+ICommandGiver
+---------------
+
+.. doxygenfile:: i_command_giver.h
+    :project: codecharacterdocs
+
+IUpdatable
+--------------
+
+.. doxygenfile:: i_updatable.h
+    :project: codecharacterdocs
+
+ICommandTaker
+----------------
+
+.. doxygenfile:: i_command_taker.h
+    :project: codecharacterdocs
+
+IStateSyncer
+-----------------
+
+.. doxygenfile:: i_state_syncer.h
+    :project: codecharacterdocs
+
+CommandGiver
+=============
+
+.. doxygenfile:: command_giver.h
+    :project: codecharacterdocs
+
+StateSyncer
+=============
+
+.. doxygenfile:: state_syncer.h
+    :project: codecharacterdocs
+
+Actor
+==========
+
+Actor
+---------
+
+.. doxygenfile:: state/actor/actor.h
+    :project: codecharacterdocs
+
+Blaster
+----------
+
+.. doxygenfile:: state/actor/blaster.h
+    :project: codecharacterdocs
+
+Tower
+----------
+
+.. doxygenfile:: state/actor/tower.h
+    :project: codecharacterdocs
+
+Unit
+----------
+
+.. doxygenfile:: state/actor/unit.h
+    :project: codecharacterdocs
+
+Bot
+----------
+
+.. doxygenfile:: state/actor/bot.h
+    :project: codecharacterdocs
+
+IActorState
+-------------
+
+.. doxygenfile:: i_actor_state.h
+    :project: codecharacterdocs
+
+Tower State
+--------------
+
+.. doxygenfile:: tower_state.h
+    :project: codecharacterdocs
+
+Tower Idle State
+^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: tower_idle_state.h
+    :project: codecharacterdocs
+
+Tower Blast State
+^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: tower_blast_state.h
+    :project: codecharacterdocs
+
+Tower Dead State
+^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: tower_dead_state.h
+    :project: codecharacterdocs
+
+Bot State
+------------
+
+.. doxygenfile:: bot_state.h
+    :project: codecharacterdocs
+
+Bot Idle State
+^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: bot_idle_state.h
+    :project: codecharacterdocs
+
+Map
+==========
+
+.. doxygenfile:: state/map/map.h
+    :project: codecharacterdocs
+
+Path Planner
+==================
+
+Graph
+----------
+
+Graph
+^^^^^^^^^
+
+.. doxygenfile:: graph.h
+    :project: codecharacterdocs
+
+Open List Entry
+^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: open_list_entry.h
+    :project: codecharacterdocs
+
+Path Graph
+-------------
+
+.. doxygenfile:: path_graph.h
+    :project: codecharacterdocs
+
+IPathPlanner
+----------------
+.. doxygenfile:: i_path_planner.h
+    :project: codecharacterdocs
+
+Path Planner
+----------------
+
+.. doxygenfile:: path_planner.h
+    :project: codecharacterdocs
+
+Score Manager
+=================
+
+.. doxygenfile:: state/score_manager/score_manager.h
+    :project: codecharacterdocs

src/logger/include/logger/error_type.h

@@ -1,5 +1,5 @@
 /**
- * file error_type.h
+ * @file error_type.h
  * Defines a type of error to be logged
  */