diff options
author | James Cowgill <james410@cowgill.org.uk> | 2014-12-09 20:21:40 +0000 |
---|---|---|
committer | James Cowgill <james410@cowgill.org.uk> | 2014-12-09 20:21:40 +0000 |
commit | fa21c65d0c764705cfc377bf0d0de08fac26874e (patch) | |
tree | dbc9e87bbd8684d15e79fc0c8b7a8985389c3b35 /doc/mainpage.hpp | |
parent | dd835931261c340acd5f0409341d13fa2670423e (diff) |
Imported Upstream version 2.2.0+dfsg
Diffstat (limited to 'doc/mainpage.hpp')
-rw-r--r-- | doc/mainpage.hpp | 142 |
1 files changed, 71 insertions, 71 deletions
diff --git a/doc/mainpage.hpp b/doc/mainpage.hpp index 9ec687c..ed6bea8 100644 --- a/doc/mainpage.hpp +++ b/doc/mainpage.hpp @@ -1,71 +1,71 @@ -////////////////////////////////////////////////////////////
-/// \mainpage
-///
-/// \section welcome Welcome
-/// Welcome to the official SFML documentation. Here you will find a detailed
-/// view of all the SFML <a href="./annotated.php">classes</a> and functions. <br/>
-/// If you are looking for tutorials, you can visit the official website
-/// at <a href="http://www.sfml-dev.org/">www.sfml-dev.org</a>.
-///
-/// \section example Short example
-/// Here is a short example, to show you how simple it is to use SFML :
-///
-/// \code
-///
-/// #include <SFML/Audio.hpp>
-/// #include <SFML/Graphics.hpp>
-///
-/// int main()
-/// {
-/// // Create the main window
-/// sf::RenderWindow window(sf::VideoMode(800, 600), "SFML window");
-///
-/// // Load a sprite to display
-/// sf::Texture texture;
-/// if (!texture.loadFromFile("cute_image.jpg"))
-/// return EXIT_FAILURE;
-/// sf::Sprite sprite(texture);
-///
-/// // Create a graphical text to display
-/// sf::Font font;
-/// if (!font.loadFromFile("arial.ttf"))
-/// return EXIT_FAILURE;
-/// sf::Text text("Hello SFML", font, 50);
-///
-/// // Load a music to play
-/// sf::Music music;
-/// if (!music.openFromFile("nice_music.ogg"))
-/// return EXIT_FAILURE;
-///
-/// // Play the music
-/// music.play();
-///
-/// // Start the game loop
-/// while (window.isOpen())
-/// {
-/// // Process events
-/// sf::Event event;
-/// while (window.pollEvent(event))
-/// {
-/// // Close window : exit
-/// if (event.type == sf::Event::Closed)
-/// window.close();
-/// }
-///
-/// // Clear screen
-/// window.clear();
-///
-/// // Draw the sprite
-/// window.draw(sprite);
-///
-/// // Draw the string
-/// window.draw(text);
-///
-/// // Update the window
-/// window.display();
-/// }
-///
-/// return EXIT_SUCCESS;
-/// }
-/// \endcode
-////////////////////////////////////////////////////////////
+//////////////////////////////////////////////////////////// +/// \mainpage +/// +/// \section welcome Welcome +/// Welcome to the official SFML documentation. Here you will find a detailed +/// view of all the SFML <a href="./annotated.php">classes</a> and functions. <br/> +/// If you are looking for tutorials, you can visit the official website +/// at <a href="http://www.sfml-dev.org/">www.sfml-dev.org</a>. +/// +/// \section example Short example +/// Here is a short example, to show you how simple it is to use SFML: +/// +/// \code +/// +/// #include <SFML/Audio.hpp> +/// #include <SFML/Graphics.hpp> +/// +/// int main() +/// { +/// // Create the main window +/// sf::RenderWindow window(sf::VideoMode(800, 600), "SFML window"); +/// +/// // Load a sprite to display +/// sf::Texture texture; +/// if (!texture.loadFromFile("cute_image.jpg")) +/// return EXIT_FAILURE; +/// sf::Sprite sprite(texture); +/// +/// // Create a graphical text to display +/// sf::Font font; +/// if (!font.loadFromFile("arial.ttf")) +/// return EXIT_FAILURE; +/// sf::Text text("Hello SFML", font, 50); +/// +/// // Load a music to play +/// sf::Music music; +/// if (!music.openFromFile("nice_music.ogg")) +/// return EXIT_FAILURE; +/// +/// // Play the music +/// music.play(); +/// +/// // Start the game loop +/// while (window.isOpen()) +/// { +/// // Process events +/// sf::Event event; +/// while (window.pollEvent(event)) +/// { +/// // Close window: exit +/// if (event.type == sf::Event::Closed) +/// window.close(); +/// } +/// +/// // Clear screen +/// window.clear(); +/// +/// // Draw the sprite +/// window.draw(sprite); +/// +/// // Draw the string +/// window.draw(text); +/// +/// // Update the window +/// window.display(); +/// } +/// +/// return EXIT_SUCCESS; +/// } +/// \endcode +//////////////////////////////////////////////////////////// |