From aadabefb2590df5877034a259f5c27b02c0a54cd Mon Sep 17 00:00:00 2001 From: Bestin Date: Wed, 19 Feb 2020 01:43:54 +0530 Subject: [PATCH 1/3] mod docs --- .gitignore | 1 + Doxyfile | 2 +- docs/source/constants.rst | 6 ++ docs/source/drivers.rst | 22 ++++++ docs/source/index.rst | 19 +++--- docs/source/logger.rst | 28 ++++++++ docs/source/physics.rst | 9 +++ docs/source/player_wrapper.rst | 27 ++++++++ docs/source/state.rst | 119 +++++++++++++++++++++++++++++++++ 9 files changed, 221 insertions(+), 12 deletions(-) create mode 100644 docs/source/constants.rst create mode 100644 docs/source/drivers.rst create mode 100644 docs/source/logger.rst create mode 100644 docs/source/physics.rst create mode 100644 docs/source/player_wrapper.rst create mode 100644 docs/source/state.rst diff --git a/.gitignore b/.gitignore index e8a3d940..865495c1 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ build/* simulator/* docs/build/* docs/xml/* +docs/html/* diff --git a/Doxyfile b/Doxyfile index 625e47a2..dc7f405d 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1122,7 +1122,7 @@ IGNORE_PREFIX = # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. -GENERATE_HTML = NO +GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/docs/source/constants.rst b/docs/source/constants.rst new file mode 100644 index 00000000..5032175f --- /dev/null +++ b/docs/source/constants.rst @@ -0,0 +1,6 @@ +========= +Constants +========= + +.. doxygennamespace:: Constants + :project: codecharacterdocs diff --git a/docs/source/drivers.rst b/docs/source/drivers.rst new file mode 100644 index 00000000..df9ad4d7 --- /dev/null +++ b/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 diff --git a/docs/source/index.rst b/docs/source/index.rst index c4e5707e..b1b7f6c8 100644 --- a/docs/source/index.rst +++ b/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` diff --git a/docs/source/logger.rst b/docs/source/logger.rst new file mode 100644 index 00000000..0acae922 --- /dev/null +++ b/docs/source/logger.rst @@ -0,0 +1,28 @@ +============ +Logger +============ + + +Namespace +============ + +.. doxygennamespace:: logger + :project: codecharacterdocs + +ILogger +============ + +.. doxygenfile:: i_logger.h + :project: codecharacterdocs + +Logger +============ + +.. doxygenfile:: logger.h + :project: codecharacterdocs + +Error Type +============ + +.. doxygenenum:: logger::ErrorType + :project: codecharacterdocs diff --git a/docs/source/physics.rst b/docs/source/physics.rst new file mode 100644 index 00000000..fb9729d1 --- /dev/null +++ b/docs/source/physics.rst @@ -0,0 +1,9 @@ +========== +Physics +========== + +vector +========== + +.. doxygenfile:: vector.hpp + :project: codecharacterdocs diff --git a/docs/source/player_wrapper.rst b/docs/source/player_wrapper.rst new file mode 100644 index 00000000..c12b8880 --- /dev/null +++ b/docs/source/player_wrapper.rst @@ -0,0 +1,27 @@ +========== +Player Wrapper +========== + +Namespace +========== + +.. doxygennamespace:: player_wrapper + :project: codecharacterdocs + +Player Wrapper +========== + +.. doxygenfile:: player_code_wrapper.h + :project: codecharacterdocs + +IPlayerCode +========== + +.. doxygenfile:: i_player_code.h + :project: codecharacterdocs + +Transfer State +========== + +.. doxygenfile:: transfer_state.h + :project: codecharacterdocs diff --git a/docs/source/state.rst b/docs/source/state.rst new file mode 100644 index 00000000..9e3fc1bb --- /dev/null +++ b/docs/source/state.rst @@ -0,0 +1,119 @@ +========== +State +========== + + +Namespace +========== + +.. doxygennamespace:: state + :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 + +Actor +========== + +.. doxygenfile:: state/actor/actor.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 + +Bot State +---------- + +.. doxygenfile:: bot_state.h + :project: codecharacterdocs + + + +Path Planner +========== + +IPathPlanner +---------- +.. doxygenfile:: i_path_planner.h + :project: codecharacterdocs + +Path Graph +---------- + +.. doxygenfile:: path_graph.h + :project: codecharacterdocs + +Graph +---------- + +.. doxygenfile:: graph.h + :project: codecharacterdocs + +Open List Entry +^^^^^^^^^^ + +.. doxygenfile:: open_list_entry.h + :project: codecharacterdocs + +Map +========== + +.. doxygenfile:: state/map/map.h + :project: codecharacterdocs + +Score Manager +========== + +.. doxygenfile:: state/score_manager/score_manager.h + :project: codecharacterdocs From c2119a073a5faa12e48eb56ec02522aaec72bf5b Mon Sep 17 00:00:00 2001 From: Bestin Date: Fri, 21 Feb 2020 00:30:18 +0530 Subject: [PATCH 2/3] fixup! mod docs --- docs/source/conf.py | 4 +- docs/source/constants.rst | 21 ++++- docs/source/drivers.rst | 6 +- docs/source/logger.rst | 9 +- docs/source/physics.rst | 1 + docs/source/player_wrapper.rst | 21 ++--- docs/source/state.rst | 110 ++++++++++++++++++++----- src/logger/include/logger/error_type.h | 2 +- 8 files changed, 129 insertions(+), 45 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index b73113a3..917b8a7b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -58,4 +58,6 @@ breathe_projects = { "codecharacterdocs": "../xml" } #Specify a default project: -breathe_default_project = "codecharacterdocs" \ No newline at end of file +breathe_default_project = "codecharacterdocs" + +breathe_domain_by_extension = {"h" : "cpp" } diff --git a/docs/source/constants.rst b/docs/source/constants.rst index 5032175f..bc5c5e36 100644 --- a/docs/source/constants.rst +++ b/docs/source/constants.rst @@ -1,6 +1,21 @@ -========= +============ Constants -========= +============ -.. doxygennamespace:: Constants +Actor +======= + +.. doxygenfile:: constants/actor.h + :project: codecharacterdocs + +Map +======= + +.. doxygenfile:: constants/map.h + :project: codecharacterdocs + +Score +======= + +.. doxygenfile:: constants/score_manager.h :project: codecharacterdocs diff --git a/docs/source/drivers.rst b/docs/source/drivers.rst index df9ad4d7..1bc71435 100644 --- a/docs/source/drivers.rst +++ b/docs/source/drivers.rst @@ -4,19 +4,19 @@ 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 diff --git a/docs/source/logger.rst b/docs/source/logger.rst index 0acae922..eab57ab1 100644 --- a/docs/source/logger.rst +++ b/docs/source/logger.rst @@ -6,8 +6,12 @@ Logger Namespace ============ +Logger +----------- + .. doxygennamespace:: logger :project: codecharacterdocs + :outline: ILogger ============ @@ -21,8 +25,3 @@ Logger .. doxygenfile:: logger.h :project: codecharacterdocs -Error Type -============ - -.. doxygenenum:: logger::ErrorType - :project: codecharacterdocs diff --git a/docs/source/physics.rst b/docs/source/physics.rst index fb9729d1..32405e84 100644 --- a/docs/source/physics.rst +++ b/docs/source/physics.rst @@ -7,3 +7,4 @@ vector .. doxygenfile:: vector.hpp :project: codecharacterdocs + diff --git a/docs/source/player_wrapper.rst b/docs/source/player_wrapper.rst index c12b8880..80af9afa 100644 --- a/docs/source/player_wrapper.rst +++ b/docs/source/player_wrapper.rst @@ -1,27 +1,28 @@ -========== +================ Player Wrapper -========== +================ Namespace ========== .. doxygennamespace:: player_wrapper :project: codecharacterdocs + :outline: + +Transfer State +================ -Player Wrapper -========== - -.. doxygenfile:: player_code_wrapper.h +.. doxygenfile:: transfer_state.h :project: codecharacterdocs IPlayerCode -========== +============= .. doxygenfile:: i_player_code.h :project: codecharacterdocs -Transfer State -========== +Player Wrapper +=============== -.. doxygenfile:: transfer_state.h +.. doxygenfile:: player_code_wrapper.h :project: codecharacterdocs diff --git a/docs/source/state.rst b/docs/source/state.rst index 9e3fc1bb..e8853e45 100644 --- a/docs/source/state.rst +++ b/docs/source/state.rst @@ -8,40 +8,75 @@ 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 ---------- @@ -61,59 +96,90 @@ Bot :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 -Path Planner +Map ========== -IPathPlanner ----------- -.. doxygenfile:: i_path_planner.h +.. doxygenfile:: state/map/map.h :project: codecharacterdocs -Path Graph ----------- - -.. doxygenfile:: path_graph.h - :project: codecharacterdocs +Path Planner +================== Graph ---------- +Graph +^^^^^^^^^ + .. doxygenfile:: graph.h :project: codecharacterdocs Open List Entry -^^^^^^^^^^ +^^^^^^^^^^^^^^^^^ .. doxygenfile:: open_list_entry.h :project: codecharacterdocs -Map -========== +Path Graph +------------- -.. doxygenfile:: state/map/map.h +.. 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 diff --git a/src/logger/include/logger/error_type.h b/src/logger/include/logger/error_type.h index cbc3a813..989248b5 100644 --- a/src/logger/include/logger/error_type.h +++ b/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 */ From 1eeed3c8381f2f5845b426fc68d9f5ba3286b8c2 Mon Sep 17 00:00:00 2001 From: Bestin Date: Sun, 23 Feb 2020 19:47:28 +0530 Subject: [PATCH 3/3] removed html --- Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index dc7f405d..625e47a2 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1122,7 +1122,7 @@ IGNORE_PREFIX = # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. -GENERATE_HTML = YES +GENERATE_HTML = NO # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of