mirror of https://github.com/encounter/SDL.git
Rearrange documentation
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
parent
0c09ce2b34
commit
f982d08784
|
|
@ -1,5 +1,4 @@
|
|||
================================================================================
|
||||
Simple DirectMedia Layer for Android
|
||||
Android
|
||||
================================================================================
|
||||
|
||||
Requirements:
|
||||
|
|
@ -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
|
||||
approach has suffered from several issues across the different supported
|
||||
|
|
@ -1,4 +1,5 @@
|
|||
SDL on DirectFB
|
||||
DirectFB
|
||||
========
|
||||
|
||||
Supports:
|
||||
|
||||
|
|
@ -1,4 +1,3 @@
|
|||
================================================================================
|
||||
Dynamic API
|
||||
================================================================================
|
||||
Originally posted by Ryan at https://plus.google.com/103391075724026391227/posts/TB8UfnDYu4U
|
||||
|
|
@ -1,4 +1,3 @@
|
|||
===========================================================================
|
||||
Dollar Gestures
|
||||
===========================================================================
|
||||
SDL Provides an implementation of the $1 gesture recognition system. This allows for recording, saving, loading, and performing single stroke gestures.
|
||||
|
|
@ -1,3 +1,6 @@
|
|||
Mercurial
|
||||
=========
|
||||
|
||||
The latest development version of SDL is available via Mercurial.
|
||||
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
|
||||
|
|
@ -1,3 +1,6 @@
|
|||
iOS
|
||||
======
|
||||
|
||||
==============================================================================
|
||||
Building the Simple DirectMedia Layer for iPhone OS 5.1
|
||||
==============================================================================
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
================================================================================
|
||||
Simple DirectMedia Layer for Linux
|
||||
Linux
|
||||
================================================================================
|
||||
|
||||
By default SDL will only link against glibc, the rest of the features will be
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
==============================================================================
|
||||
Using the Simple DirectMedia Layer with Mac OS X
|
||||
Mac OS X
|
||||
==============================================================================
|
||||
|
||||
These instructions are for people using Apple's Mac OS X (pronounced
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
================================================================================
|
||||
Simple DirectMedia Layer for Native Client
|
||||
Native Client
|
||||
================================================================================
|
||||
|
||||
Requirements:
|
||||
|
|
@ -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
|
||||
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.
|
||||
|
|
@ -1,3 +1,6 @@
|
|||
Platforms
|
||||
=========
|
||||
|
||||
|
||||
This is a list of the platforms SDL supports, and who maintains them.
|
||||
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
Porting
|
||||
=======
|
||||
|
||||
* Porting To A New Platform
|
||||
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
PSP
|
||||
======
|
||||
SDL port for the Sony PSP contributed by
|
||||
Captian Lex
|
||||
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
================================================================================
|
||||
SDL2 for Raspberry Pi
|
||||
Raspberry Pi
|
||||
================================================================================
|
||||
|
||||
Requirements:
|
||||
|
|
@ -1,3 +1,4 @@
|
|||
Touch
|
||||
===========================================================================
|
||||
System Specific Notes
|
||||
===========================================================================
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
WinCE
|
||||
=====
|
||||
|
||||
Windows CE is no longer supported by SDL.
|
||||
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
================================================================================
|
||||
Simple DirectMedia Layer for Windows
|
||||
Windows
|
||||
================================================================================
|
||||
|
||||
================================================================================
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
================================================================================
|
||||
Simple DirectMedia Layer for WinRT
|
||||
WinRT
|
||||
================================================================================
|
||||
|
||||
SDL/WinRT layer allows SDL2-based applications to run on many of Microsoft's
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
|
||||
Simple DirectMedia Layer
|
||||
Simple DirectMedia Layer {#mainpage}
|
||||
========================
|
||||
|
||||
(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
|
||||
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.
|
||||
and many Humble Bundle games. 42
|
||||
|
||||
SDL officially supports Windows, Mac OS X, Linux, iOS, and Android.
|
||||
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 "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/
|
||||
|
||||
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
|
||||
issues, you can join the developers mailing list:
|
||||
http://www.libsdl.org/mailing-list.php
|
||||
issues, you can join the [developers mailing list](http://www.libsdl.org/mailing-list.php)
|
||||
|
||||
If you want to report bugs or contribute patches, please submit them to
|
||||
bugzilla:
|
||||
http://bugzilla.libsdl.org/
|
||||
[bugzilla](http://bugzilla.libsdl.org/)
|
||||
|
||||
Enjoy!
|
||||
Sam Lantinga (slouken@libsdl.org)
|
||||
|
||||
|
||||
Sam Lantinga <mailto:slouken@libsdl.org>
|
||||
|
||||
|
|
@ -38,7 +38,7 @@ PROJECT_NUMBER = 2.0.0
|
|||
# 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.
|
||||
|
||||
OUTPUT_DIRECTORY = .
|
||||
OUTPUT_DIRECTORY = ./output
|
||||
|
||||
# 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
|
||||
|
|
@ -569,7 +569,7 @@ WARN_LOGFILE = ./doxygen_warn.txt
|
|||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
INPUT = .
|
||||
INPUT = . ../include
|
||||
|
||||
# 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
|
||||
|
|
@ -618,7 +618,8 @@ FILE_PATTERNS = *.c \
|
|||
*.vhd \
|
||||
*.vhdl \
|
||||
*.h.in \
|
||||
*.h.default
|
||||
*.h.default \
|
||||
*.md
|
||||
|
||||
# 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.
|
||||
|
|
@ -630,12 +631,15 @@ RECURSIVE = YES
|
|||
# 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.
|
||||
|
||||
EXCLUDE = ../doxy \
|
||||
../test \
|
||||
../Xcode \
|
||||
../VisualC \
|
||||
../VisualCE \
|
||||
../Xcode-iOS
|
||||
EXCLUDE = ../include/SDL_opengles2_gl2ext.h \
|
||||
../include/SDL_opengles2_gl2platform.h \
|
||||
../include/SDL_opengles2_khrplatform.h \
|
||||
../include/SDL_opengl_glext.h \
|
||||
../include/SDL_opengles2_gl2.h \
|
||||
../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
|
||||
# directories that are symbolic links (a Unix filesystem feature) are excluded
|
||||
|
|
@ -25,41 +25,6 @@
|
|||
* 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
|
||||
#define _SDL_H
|
||||
|
|
|
|||
Loading…
Reference in New Issue