#ifdef tb_generate_documentation
#error This file should not be included in any project. It is for generating TurtleBrains documentation using Doxygen.
//-------------------------------------------------------------------------------------------------------------------//
///
/// @page pageGameEggDropTutorial HowTo: Egg Drop Game Tutorial
/// @details The Golden Egg Drop tutorial will introduce you to creating a game using the %TurtleBrains framework. First
/// a sprite will be set as a backdrop, then basic creating basic entities that interact and collide, and finally
/// finishing with a few sound effects.
///
/// -# @subpage pageEggDropGameTutorialStep1 "Create the EggDropGameScene" derived from @ref TurtleBrains::Game::GameScene "tbGame::GameScene"
/// -# @subpage pageEggDropGameTutorialStep2 "Add a backdrop image" using @ref TurtleBrains::Graphics::Sprite "tbGraphics::Sprite"
/// -# @subpage pageEggDropGameTutorialStep3 "Create and add the BasketEntity" derived from @ref TurtleBrains::Game::Entity "tbGame::Entity"
/// -# @subpage pageEggDropGameTutorialStep4 "Create the EggEntity"
/// -# @subpage pageEggDropGameTutorialStep5 "Add the Gameplay"
/// -# @subpage pageEggDropGameTutorialStep6 "Add Sound Effects" using @ref TurtleBrains::Audio::AudioManager "tbAudio::AudioManager"
///
/// @image html "images/egg_drop_tutorial/egg_drop_gameplay.gif"
///
/// @ref pageEggDropGameTutorialStep2 "First Step: Create the EggDropGameScene"
///
//-------------------------------------------------------------------------------------------------------------------//
///
/// @page pageEggDropGameTutorialStep1 Create the EggDropGameScene
/// Each scene of a game is a class derived from @ref TurtleBrains::Game::GameScene "tbGame::GameScene" that
/// manages the objects and some of the logic for the gameplay. The following will get you started with a blank
/// scene, but that is pretty boring so we will spice it up after.
///
/// egg_drop_game_scene.h
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameEggDropSceneHeader
/// egg_drop_game_scene.cpp
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameEggDropSceneSource
///
/// @ref pageEggDropGameTutorialStep2 "Next Step"
///
//-------------------------------------------------------------------------------------------------------------------//
///
/// @page pageEggDropGameTutorialStep2 Give the Scene a Backdrop
/// That will create an extremely basic scene presenting a black screen, pretty boring so lets set the stage with a
/// simple backdop.
///
/// modify egg_drop_game_scene.cpp
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameEggDropSceneSpriteSource
///
/// @ref pageEggDropGameTutorialStep1 "Previous Step" :: @ref pageEggDropGameTutorialStep3 "Next Step"
///
//-------------------------------------------------------------------------------------------------------------------//
///
/// @page pageEggDropGameTutorialStep3 Add an Interactive Entity
///
/// Now we can add awesome things to the game. [documentation still in progress, need to write a full sample project]
///
/// basket_entity.h
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameBasketEntityHeader
/// basket_entity.cpp
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameBasketEntitySource
///
/// @ref pageEggDropGameTutorialStep2 "Previous Step" :: @ref pageEggDropGameTutorialStep4 "Next Step"
///
//-------------------------------------------------------------------------------------------------------------------//
///
/// @page pageEggDropGameTutorialStep4 Add the EggEntity
///
/// Now we can add awesome things to the game. [documentation still in progress, need to write a full sample project]
///
/// egg_entity.h
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameEggEntityHeader
/// egg_entity.cpp
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameEggEntitySource
///
/// @ref pageEggDropGameTutorialStep3 "Previous Step" :: @ref pageEggDropGameTutorialStep5 "Next Step"
///
//-------------------------------------------------------------------------------------------------------------------//
///
/// @page pageEggDropGameTutorialStep5 Add Gameplay
///
/// egg_drop_game_scene.h
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameEggDropSceneEggSpawnSource
/// egg_drop_game_scene.cpp
/// @snippet tb_egg_drop_game_example.cpp exampleEggDropGameEggDropSceneEggSpawnSource
///
/// @ref pageEggDropGameTutorialStep4 "Previous Step" :: @ref pageEggDropGameTutorialStep6 "Next Step"
///
//-------------------------------------------------------------------------------------------------------------------//
///
/// @page pageEggDropGameTutorialStep6 Add Sound Effects
///
/// Now we can add awesome things to the game. [documentation still in progress, need to write a full sample project]
/// Blah blah blah....
///
/// @ref pageEggDropGameTutorialStep4 "Previous Step"
///
//-------------------------------------------------------------------------------------------------------------------//
#endif /* tb_generate_documentation */