lauchmelder/SFML
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Moved CSFML documentation build files from root to doc\build

Browse source 
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/trunk@1170 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
LaurentGom 2009-07-12 09:56:24 +00:00
parent 5c84825759
commit 5972c22d89
8 changed files with 1523 additions and 239 deletions
Download patch file Download diff file Expand all files Collapse all files

1513
CSFML/doc/build/Doxyfile vendored Normal file
View file

File diff suppressed because it is too large Load diff

95
CSFML/doc/build/Doxygen.hpp vendored Normal file
View file

@ -0,0 +1,95 @@
////////////////////////////////////////////////////////////
/// \mainpage
///
/// \section welcome Welcome
/// Welcome to the official SFML documentation for C. Here you will find a detailed
/// view of all the SFML <a href="./globals_func.htm">functions</a>, as well as source
/// <a href="./files.htm">files</a>. <br/>
/// If you are looking for tutorials, you can visit the official website
/// at <a href="http://www.sfml-dev.org/tutorials/">www.sfml-dev.org</a>.
///
/// \section example Short example
/// Here is a short example, to show you how simple it is to use SFML in C :
///
/// \code
///
/// #include <SFML/Audio.h>
/// #include <SFML/Graphics.h>
///
/// int main()
/// {
/// sfWindowSettings Settings = {24, 8, 0};
/// sfVideoMode Mode = {800, 600, 32};
/// sfRenderWindow* App;
/// sfImage* Image;
/// sfSprite* Sprite;
/// sfFont* Font;
/// sfString* Text;
/// sfMusic* Music;
/// sfEvent Event;
///
/// /* Create the main window */
/// App = sfRenderWindow_Create(Mode, "SFML window", sfResize | sfClose, Settings);
/// if (!App)
/// return EXIT_FAILURE;
///
/// /* Load a sprite to display */
/// Image = sfImage_CreateFromFile("cute_image.jpg");
/// if (!Image)
/// return EXIT_FAILURE;
/// Sprite = sfSprite_Create();
/// sfSprite_SetImage(Sprite, Image);
///
/// /* Create a graphical string to display */
/// Font = sfFont_CreateFromFile("arial.ttf", 50, NULL);
/// if (!Font)
/// return EXIT_FAILURE;
/// Text = sfString_Create();
/// sfString_SetText(Text, "Hello SFML");
/// sfString_SetFont(Text, Font);
/// sfString_SetSize(Text, 50);
///
/// /* Load a music to play */
/// Music = sfMusic_CreateFromFile("nice_music.ogg");
/// if (!Music)
/// return EXIT_FAILURE;
///
/// /* Play the music */
/// sfMusic_Play(Music);
///
/// /* Start the game loop */
/// while (sfRenderWindow_IsOpened(App))
/// {
/// /* Process events */
/// while (sfRenderWindow_GetEvent(App, &Event))
/// {
/// /* Close window : exit */
/// if (Event.Type == sfEvtClosed)
/// sfRenderWindow_Close(App);
/// }
///
/// /* Clear the screen */
/// sfRenderWindow_Clear(App, sfBlack);
///
/// /* Draw the sprite */
/// sfRenderWindow_DrawSprite(App, Sprite);
///
/// /* Draw the string */
/// sfRenderWindow_DrawString(App, Text);
///
/// /* Update the window */
/// sfRenderWindow_Display(App);
/// }
///
/// /* Cleanup resources */
/// sfMusic_Destroy(Music);
/// sfString_Destroy(Text);
/// sfFont_Destroy(Font);
/// sfSprite_Destroy(Sprite);
/// sfImage_Destroy(Image);
/// sfRenderWindow_Destroy(App);
///
/// return EXIT_SUCCESS;
/// }
/// \endcode
////////////////////////////////////////////////////////////

8
CSFML/doc/build/footer.htm vendored Normal file
View file

@ -0,0 +1,8 @@
<p id="footer">
&nbsp;::&nbsp; Copyright &copy; 2007 Laurent Gomila, all rights reserved &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> &nbsp;::&nbsp;
</p>
</body>
</html>

12
CSFML/doc/build/header.htm vendored Normal file
View file

@ -0,0 +1,12 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="tabs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="logo">
<img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
</div>