Mercurial > sdl-ios-xcode
view VisualC.html @ 5067:61d53410eb41
Fixed bug #859
CREATE_SUBDIRS helps a lot if browsing HTML documentation in a file browser.
ALWAYS_DETAILED_SEC makes sure everything has at least the automatic
documentation like function prototype and source references.
STRIP_FROM_PATH allows you to include only the relevant portions of the files'
paths, cleaning up both the file list and directory tree, though you need to
change the path listed here to match wherever you put SDL.
ALIASES avoids some warnings generated by
C:\source\svn.libsdl.org\trunk\SDL\src\joystick\darwin\10.3.9-FIX\IOHIDLib.h.
It seems Apple uses a few commands which are not normally supported by Doxygen.
BUILTIN_STL_SUPPORT adds support for parsing code which makes use of the
standard template library. There isn't a lot of C++ in SDL (some in bwindow at
least), but this still seems like a good idea.
TYPEDEF_HIDES_STRUCT means that for code like this:
typedef struct A {int B;} C;
C is documented as a structure containing B instead of a typedef mapped to A.
EXTRACT_ALL, EXTRACT_PRIVATE, EXTRACT_STATIC, EXTRACT_LOCAL_METHODS,
EXTRACT_ANON_NSPACES and INTERNAL_DOCS make sure that _everything_ is
documented.
CASE_SENSE_NAMES = NO avoids potential conflicts when building documentation on
case insensitive file systems like NTFS and FAT32.
WARN_NO_PARAMDOC lets you know when you have documented some, but not all, of
the parameters of a function. This is useful when you're working on adding
such documentation since it makes partially documented functions easier to
spot.
WARN_LOGFILE writes warnings to a seperate file instead of mixing them in with
stdout. When not running in quiet mode, these warnings can be hard to spot
without this flag.
I added *.h.in and *.h.default to FILE_PATTERNS to generate documentation for
config.h.in and config.h.default.
RECURSIVE tells doxygen to look not only in the input directory, but also in
subfolders.
EXCLUDE avoids documenting things like test programs, examples and templates
which need to be documented separately.
I've used EXCLUDE_PATTERNS to exclude non-source subdirectories that often find
their way into source folders (such as obj or .svn).
EXAMPLE_PATH lists directories doxygen will search to find included example
code. So far, SDL doesn't really use this feature, but I've listed some likely
locations.
SOURCE_BROWSER adds syntax highlighted source code to the HTML output.
USE_HTAGS is nice, but not available on Windows.
INLINE_SOURCES adds the body of a function to it's documentation so you can
quickly see exactly what it does.
ALPHABETICAL_INDEX generates an alphabetical list of all structures, functions,
etc., which makes it much easier to find what you're looking for.
IGNORE_PREFIX skips the SDL_ prefix when deciding which index page to place an
item on so you don't have everything show up under "S".
HTML_DYNAMIC_SECTIONS hides the includes/included by diagrams by default and
adds JavaScript to allow the user to show and hide them by clicking a link.
ENUM_VALUES_PER_LINE = 1 makes enums easier to read by placing each value on
it's own line.
GENERATE_TREEVIEW produces a two frame index page with a navigation tree on the
left.
I have LaTeX and man pages turned off to speed up doxygen, you may want to turn
them back on yourself.
I added _WIN32=1 to PREDEFINED to cause SDL to output documentation related to
Win32 builds of SDL. Normally, doxygen gets confused since there are multiple
definitions for various structures and formats that vary by platform. Without
this doxygen can produce broken documentation or, if you're lucky, output
documentation only for the dummy drivers, which isn't very useful. You need to
pick a platform.
GENERATE_TAGFILE produces a file which can be used to link other doxygen
documentation to the SDL documentation.
CLASS_DIAGRAMS turns on class diagrams even when dot is not available.
HAVE_DOT tells doxygen to try to use dot to generate diagrams.
TEMPLATE_RELATIONS and INCLUDE_GRAPH add additional diagrams to the
documentation.
DOT_MULTI_TARGETS speeds up dot.
OUTPUT_DIRECTORY, INPUT and other paths reflect the fact that this Doxyfile is
intended to process src as well as include and is being run from a separate
subdirectory. Doxygen produces several temporary files while it's running and
if interrupted, can leave those files behind. It's easier to clean up if there
aren't a hundred or so files in the same folder. I typically run doxygen in
SDL/doxy and set the output directory to '.'. Since doxygen puts it's output
in subfolders by type, this keeps things pretty well organised. You could use
'../doc' instead and get the same results.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 21 Jan 2011 12:57:01 -0800 |
parents | 222aa027e650 |
children |
line wrap: on
line source
<HTML> <HEAD> <TITLE>Using SDL with Microsoft Visual C++</TITLE> </HEAD> <BODY> <H1> Using SDL with Microsoft Visual C++ 5,6 and 7 </H1> <H3> by <A HREF="mailto:snowlion@sprynet.com">Lion Kimbro </A>and additions by <A HREF="mailto:james@conceptofzero.net"> James Turk</A> </H3> <p> You can either use the precompiled libraries from <A HREF="http://www.libsdl.org/download.php"> the SDL Download web site </A>, or you can build SDL yourself. </p> <H3> Building SDL </H3> <P> Go into the VisualC directory and double-click on the VC++ file "<CODE>SDL.dsw</CODE>" <STRONG><FONT color="#009900">("<CODE>SDL.sln</CODE>")</FONT></STRONG>. This should open up the IDE. </P> <P> You may be prompted at this point to upgrade the workspace, should you be using a more recent version of Visual C++. If so, allow the workspace to be upgraded. </P> <P> Build the <CODE>.dll</CODE> and <CODE>.lib</CODE> files. </P> <P> This is done by right clicking on each project in turn (Projects are listed in the Workspace panel in the FileView tab), and selecting "Build". </P> <P> If you get an error about SDL_config.h being missing, you should copy include/SDL_config.h.default to include/SDL_config.h and try again. </P> <P> You may get a few warnings, but you should not get any errors. You do have to have at least the DirectX 5 SDK installed, however. The latest version of DirectX can be downloaded or purchased on a cheap CD (my recommendation) from <A HREF="http://www.microsoft.com">Microsoft </A>. </P> <P> Later, we will refer to the following .lib and .dll files that have just been generated: </P> <ul> <li> SDL.dll</li> <li> SDL.lib</li> <li> SDLmain.lib</li> </ul> <P> Search for these using the Windows Find (Windows-F) utility, if you don't already know where they should be. For those of you with a clue, look inside the Debug or Release directories of the subdirectories of the Project folder. (It might be easier to just use Windows Find if this sounds confusing. And don't worry about needing a clue; we all need visits from the clue fairy frequently.) </P> <H3> Creating a Project with SDL </H3> <P> Create a project as a Win32 Application. </P> <P> Create a C++ file for your project. </P> <P> Set the C runtime to "Multi-threaded DLL" in the menu: <CODE>Project|Settings|C/C++ tab|Code Generation|Runtime Library </CODE>. </P> <P> Add the SDL <CODE>include</CODE> directory to your list of includes in the menu: <CODE>Project|Settings|C/C++ tab|Preprocessor|Additional include directories </CODE> . <br> <STRONG><FONT color="#009900">VC7 Specific: Instead of doing this I find it easier to add the include and library directories to the list that VC7 keeps. Do this by selecting Tools|Options|Projects|VC++ Directories and under the "Show Directories For:" dropbox select "Include Files", and click the "New Directory Icon" and add the [SDLROOT]\include directory (ex. If you installed to c:\SDL-1.2.5\ add c:\SDL-1.2.5\include). Proceed to change the dropbox selection to "Library Files" and add [SDLROOT]\lib.</FONT></STRONG> </P> <P> The "include directory" I am referring to is the <CODE>include</CODE> folder within the main SDL directory (the one that this HTML file located within). </P> <P> Now we're going to use the files that we had created earlier in the Build SDL step. </P> <P> Copy the following files into your Project directory: </P> <ul> <li> SDL.dll</li> </ul> <P> Add the following files to your project (It is not necessary to copy them to your project directory): </P> <ul> <li> SDL.lib </li> <li> SDLmain.lib</li> </ul> <P> (To add them to your project, right click on your project, and select "Add files to project") </P> <P><STRONG><FONT color="#009900">Instead of adding the files to your project it is more desireable to add them to the linker options: Project|Properties|Linker|Command Line and type the names of the libraries to link with in the "Additional Options:" box. Note: This must be done for each build configuration (eg. Release,Debug).</FONT></STRONG></P> <H3> SDL 101, First Day of Class </H3> <P> Now create the basic body of your project. The body of your program should take the following form: <CODE> <PRE> #include "SDL.h" int main( int argc, char* argv[] ) { // Body of the program goes here. return 0; } </PRE> </CODE> <P></P> <H3> That's it! </H3> <P> I hope that this document has helped you get through the most difficult part of using the SDL: installing it. Suggestions for improvements to this document should be sent to the writers of this document. </P> <P> Thanks to Paulus Esterhazy (pesterhazy@gmx.net), for the work on VC++ port. </P> <P> This document was originally called "VisualC.txt", and was written by <A HREF="mailto:slouken@libsdl.org"> Sam Lantinga</A>. </P> <P> Later, it was converted to HTML and expanded into the document that you see today by <A HREF="mailto:snowlion@sprynet.com">Lion Kimbro</A>. </P> <P>Minor Fixes and Visual C++ 7 Information (In Green) was added by <A HREF="mailto:james@conceptofzero.net">James Turk</A> </P> </BODY> </HTML>