Relintai/sdl2_frt
1
0
Fork 0
mirror of https://github.com/Relintai/sdl2_frt.git synced 2025-02-04 11:15:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rearrange documentation

Browse Source 
1) Moves all READMEs to docs/
2) Renames them to *.md, adds some Markdown with the idea to add a lot more
3) Moves the doxyfile config to doc/ and makes it parse the headers at ../include as well as the md files in docs.
4) Skips SDL_opengl*.h headers from the docs
5) Minor fixes to doxyfile
This commit is contained in:
Gabriel Jacobo 2014-07-29 09:20:12 -03:00
parent 0c09ce2b34
commit f982d08784
23 changed files with 106 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
README-SDL.txt → doc/README-SDL.md
View File

3
README-android.txt → doc/README-android.md
View File

@ -1,5 +1,4 @@
================================================================================ Android
Simple DirectMedia Layer for Android
================================================================================ ================================================================================
Requirements: Requirements:

4
README-cmake.txt → doc/README-cmake.md
View File

@ -1,6 +1,6 @@
CMake
================================================================================ ================================================================================
CMake build system for SDL (www.cmake.org) (www.cmake.org)
================================================================================
SDL's build system was traditionally based on autotools. Over time, this SDL's build system was traditionally based on autotools. Over time, this
approach has suffered from several issues across the different supported approach has suffered from several issues across the different supported

3
README-directfb.txt → doc/README-directfb.md
View File

@ -1,4 +1,5 @@
SDL on DirectFB DirectFB
========
Supports: Supports:

1
README-dynapi.txt → doc/README-dynapi.md
View File

@ -1,4 +1,3 @@
================================================================================
Dynamic API Dynamic API
================================================================================ ================================================================================
Originally posted by Ryan at https://plus.google.com/103391075724026391227/posts/TB8UfnDYu4U Originally posted by Ryan at https://plus.google.com/103391075724026391227/posts/TB8UfnDYu4U

1
README-gesture.txt → doc/README-gesture.md
View File

@ -1,4 +1,3 @@
===========================================================================
Dollar Gestures Dollar Gestures
=========================================================================== ===========================================================================
SDL Provides an implementation of the $1 gesture recognition system. This allows for recording, saving, loading, and performing single stroke gestures. SDL Provides an implementation of the $1 gesture recognition system. This allows for recording, saving, loading, and performing single stroke gestures.

3
README-hg.txt → doc/README-hg.md
View File

@ -1,3 +1,6 @@
Mercurial
=========
The latest development version of SDL is available via Mercurial. The latest development version of SDL is available via Mercurial.
Mercurial allows you to get up-to-the-minute fixes and enhancements; Mercurial allows you to get up-to-the-minute fixes and enhancements;
as a developer works on a source tree, you can use "hg" to mirror that as a developer works on a source tree, you can use "hg" to mirror that

3
README-ios.txt → doc/README-ios.md
View File

@ -1,3 +1,6 @@
iOS
======
============================================================================== ==============================================================================
Building the Simple DirectMedia Layer for iPhone OS 5.1 Building the Simple DirectMedia Layer for iPhone OS 5.1
============================================================================== ==============================================================================

3
README-linux.txt → doc/README-linux.md
View File

@ -1,5 +1,4 @@
================================================================================ Linux
Simple DirectMedia Layer for Linux
================================================================================ ================================================================================
By default SDL will only link against glibc, the rest of the features will be By default SDL will only link against glibc, the rest of the features will be

3
README-macosx.txt → doc/README-macosx.md
View File

@ -1,5 +1,4 @@
============================================================================== Mac OS X
Using the Simple DirectMedia Layer with Mac OS X
============================================================================== ==============================================================================
These instructions are for people using Apple's Mac OS X (pronounced These instructions are for people using Apple's Mac OS X (pronounced

3
README-nacl.txt → doc/README-nacl.md
View File

@ -1,5 +1,4 @@
================================================================================ Native Client
Simple DirectMedia Layer for Native Client
================================================================================ ================================================================================
Requirements: Requirements:

3
README-pandora.txt → doc/README-pandora.md
View File

@ -1,6 +1,7 @@
SDL 2.0 with open pandora console support ( http://openpandora.org/ ) Pandora
===================================================================== =====================================================================
( http://openpandora.org/ )
- A pandora specific video driver was written to allow SDL 2.0 with OpenGL ES - A pandora specific video driver was written to allow SDL 2.0 with OpenGL ES
support to work on the pandora under the framebuffer. This driver do not have support to work on the pandora under the framebuffer. This driver do not have
input support for now, so if you use it you will have to add your own control code. input support for now, so if you use it you will have to add your own control code.

3
README-platforms.txt → doc/README-platforms.md
View File

@ -1,3 +1,6 @@
Platforms
=========
This is a list of the platforms SDL supports, and who maintains them. This is a list of the platforms SDL supports, and who maintains them.

2
README-porting.txt → doc/README-porting.md
View File

@ -1,3 +1,5 @@
Porting
=======
* Porting To A New Platform * Porting To A New Platform

2
README-psp.txt → doc/README-psp.md
View File

@ -1,3 +1,5 @@
PSP
======
SDL port for the Sony PSP contributed by SDL port for the Sony PSP contributed by
Captian Lex Captian Lex

3
README-raspberrypi.txt → doc/README-raspberrypi.md
View File

@ -1,5 +1,4 @@
================================================================================ Raspberry Pi
SDL2 for Raspberry Pi
================================================================================ ================================================================================
Requirements: Requirements:

1
README-touch.txt → doc/README-touch.md
View File

@ -1,3 +1,4 @@
Touch
=========================================================================== ===========================================================================
System Specific Notes System Specific Notes
=========================================================================== ===========================================================================

2
README-wince.txt → doc/README-wince.md
View File

@ -1,3 +1,5 @@
WinCE
=====
Windows CE is no longer supported by SDL. Windows CE is no longer supported by SDL.

3
README-windows.txt → doc/README-windows.md
View File

@ -1,5 +1,4 @@
================================================================================ Windows
Simple DirectMedia Layer for Windows
================================================================================ ================================================================================
================================================================================ ================================================================================

3
README-winrt.txt → doc/README-winrt.md
View File

@ -1,5 +1,4 @@
================================================================================ WinRT
Simple DirectMedia Layer for WinRT
================================================================================ ================================================================================
SDL/WinRT layer allows SDL2-based applications to run on many of Microsoft's SDL/WinRT layer allows SDL2-based applications to run on many of Microsoft's

40
README.txt → doc/README.md
View File

@ -1,5 +1,5 @@
Simple DirectMedia Layer {#mainpage}
Simple DirectMedia Layer ========================
(SDL) (SDL)
@ -12,7 +12,7 @@ Simple DirectMedia Layer is a cross-platform development library designed
to provide low level access to audio, keyboard, mouse, joystick, and graphics to provide low level access to audio, keyboard, mouse, joystick, and graphics
hardware via OpenGL and Direct3D. It is used by video playback software, hardware via OpenGL and Direct3D. It is used by video playback software,
emulators, and popular games including Valve's award winning catalog emulators, and popular games including Valve's award winning catalog
and many Humble Bundle games. and many Humble Bundle games. 42
SDL officially supports Windows, Mac OS X, Linux, iOS, and Android. SDL officially supports Windows, Mac OS X, Linux, iOS, and Android.
Support for other platforms may be found in the source code. Support for other platforms may be found in the source code.
@ -26,17 +26,37 @@ in the file "COPYING.txt".
The best way to learn how to use SDL is to check out the header files in The best way to learn how to use SDL is to check out the header files in
the "include" subdirectory and the programs in the "test" subdirectory. the "include" subdirectory and the programs in the "test" subdirectory.
The header files and test programs are well commented and always up to date. The header files and test programs are well commented and always up to date.
More documentation and FAQs are available online at:
http://wiki.libsdl.org/ More documentation and FAQs are available online at [the wiki](http://wiki.libsdl.org/)
- [Android](README-android.md)
- [CMake](README-cmake.md)
- [DirectFB](README-directfb.md)
- [DynAPI](README-dynapi.md)
- [Gesture](README-gesture.md)
- [Mercurial](README-hg.md)
- [iOS](README-ios.md)
- [Linux](README-linux.md)
- [OS X](README-macosx.md)
- [Native Client](README-nacl.md)
- [Pandora](README-pandora.md)
- [Supported Platforms](README-platforms.md)
- [Porting information](README-porting.md)
- [PSP](README-psp.md)
- [Raspberry Pi](README-raspberrypi.md)
- [Touch](README-touch.md)
- [WinCE](README-wince.md)
- [Windows](README-windows.md)
- [WinRT](README-winrt.md)
If you need help with the library, or just want to discuss SDL related If you need help with the library, or just want to discuss SDL related
issues, you can join the developers mailing list: issues, you can join the [developers mailing list](http://www.libsdl.org/mailing-list.php)
http://www.libsdl.org/mailing-list.php
If you want to report bugs or contribute patches, please submit them to If you want to report bugs or contribute patches, please submit them to
bugzilla: [bugzilla](http://bugzilla.libsdl.org/)
http://bugzilla.libsdl.org/
Enjoy! Enjoy!
Sam Lantinga (slouken@libsdl.org)
Sam Lantinga <mailto:slouken@libsdl.org>

22
include/doxyfile → doc/doxyfile
View File

@ -38,7 +38,7 @@ PROJECT_NUMBER = 2.0.0
# If a relative path is entered, it will be relative to the location # If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = . OUTPUT_DIRECTORY = ./output
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output # 4096 sub-directories (in 2 levels) under the output directory of each output
@ -569,7 +569,7 @@ WARN_LOGFILE = ./doxygen_warn.txt
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = . INPUT = . ../include
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -618,7 +618,8 @@ FILE_PATTERNS = *.c \
*.vhd \ *.vhd \
*.vhdl \ *.vhdl \
*.h.in \ *.h.in \
*.h.default *.h.default \
*.md
# The RECURSIVE tag can be used to turn specify whether or not subdirectories # The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO. # should be searched for input files as well. Possible values are YES and NO.
@ -630,12 +631,15 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a # excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag. # subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = ../doxy \ EXCLUDE = ../include/SDL_opengles2_gl2ext.h \
../test \ ../include/SDL_opengles2_gl2platform.h \
../Xcode \ ../include/SDL_opengles2_khrplatform.h \
../VisualC \ ../include/SDL_opengl_glext.h \
../VisualCE \ ../include/SDL_opengles2_gl2.h \
../Xcode-iOS ../include/SDL_opengles2.h \
../include/SDL_opengles.h \
../include/SDL_opengl.h \
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded # directories that are symbolic links (a Unix filesystem feature) are excluded

35
include/SDL.h
View File

@ -25,41 +25,6 @@
* Main include header for the SDL library * Main include header for the SDL library
*/ */
/**
* \mainpage Simple DirectMedia Layer (SDL)
*
* http://www.libsdl.org/
*
* \section intro_sec Introduction
*
* Simple DirectMedia Layer is a cross-platform development library designed
* to provide low level access to audio, keyboard, mouse, joystick, and
* graphics hardware via OpenGL and Direct3D. It is used by video playback
* software, emulators, and popular games including Valve's award winning
* catalog and many Humble Bundle games.
*
* SDL officially supports Windows, Mac OS X, Linux, iOS, and Android.
* Support for other platforms may be found in the source code.
*
* SDL is written in C, works natively with C++, and there are bindings
* available for several other languages, including C# and Python.
*
* This library is distributed under the zlib license, which can be found
* in the file "COPYING.txt".
*
* The best way to learn how to use SDL is to check out the header files in
* the "include" subdirectory and the programs in the "test" subdirectory.
* The header files and test programs are well commented and always up to date.
* More documentation and FAQs are available online at:
* http://wiki.libsdl.org/
*
* If you need help with the library, or just want to discuss SDL related
* issues, you can join the developers mailing list:
* http://www.libsdl.org/mailing-list.php
*
* Enjoy!
* Sam Lantinga (slouken@libsdl.org)
*/
#ifndef _SDL_H #ifndef _SDL_H
#define _SDL_H #define _SDL_H