Mercurial > sdl-ios-xcode
view Borland.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 | de622b7108bf |
| children |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>Building SDL with Borland's C++ compilers</title> <meta name="author" content="David Snopek and updated by Dominique Louis."> </head> <body> <xevol @newtonave.net=""> </xevol> <h1>Building SDL with Borland's C++ compilers. </h1> <b> by <a href="mailto:xevol@users.sourceforge.net"> David Snopek</a></b> and updated by <b><a href="mailto:Dominique@SavageSoftware.com.au">Dominique Louis</a></b> ( Last updated : 30th June 2003 ).<br> <br> These instructions cover how to compile SDL and its included test programs using either Borland <a href="#bcbwin">C++ Builder 5, 6 for Windows</a>, <a href="#k3">C++ Builder for Linux ( AKA Kylix 3 )</a> or the free <a href="#bccc">Borland C++ command-line compiler</a>. <br> <h3> <b> Extract the files </b> </h3> <p> Unzip the Borland.zip archive into <b>this</b> directory. Do not unzip it into any other directory because the makefiles ( *.mak ) and project files ( *.bpr ) use relative paths to refer to the SDL sources. This should create a directory named "Borland" inside of the top level SDL source directory. </p> <h3> <b><a name="bcbwin"></a> Using Borland C++ Builder 5, 6 for Windows </b> </h3> <p> Inside of the "Borland" directory there is a "bcb6" directory that contains a number of Builder project files. Double-click on the "libSDL.bpg" file icon. Once Builder has started click on the "<u>P</u>rojects" menu on the menu-bar and go down to "B<u>u</u>ild All Projects" option. <br> This will proceed to build SDL ( with Borland's calling convention ), SDLmain, and all the <a href="#tests">test programs</a>. Currently, all the <a href="#tests">test programs</a> are dynamically linked to Sam Lantinga's SDL.dll.</p> <p><b>NOTE :</b> Borland's "lib" format and Microsoft's "lib" format are incompatible. <br> If you wish to dynamically link to the SDL library supplied by Sam Lantinga in each release, I have created the correct *.libs for SDL 1.2.4 and they exist in the "/lib" directory.<br> If you would like to create the *.lib files yourself, you will need to make use of Borland's "implib.exe" utility.<br> </p> <p><tt>IMPLIB</tt> works like this: </p> <pre> IMPLIB (destination lib name) (source dll)<br></pre> <p> For example,</p> <pre> IMPLIB SDL.lib SDL.dll<br></pre> <p>This assumes that SDL.dll was compiled with Visual C++ or similar.<br> </p> <p>To learn more about the difference between Borland's and Microsoft's *.lib format please read the article <a href="http://www.bcbdev.com/articles/vcdll.htm">here</a>.<br> </p> <p> <b><br> NOTE :</b> The C++ Builder for Windows project format, is not compatible with the Kylix 3 project format, hence the reason why they are in separate directories.</p> <h3> <b><a name="bccc"></a> Using the free Borland C++ command-line compiler </b> </h3> <p> The free Borland compiler can be downloaded at no charge from <a href="http://www.borland.com/bcppbuilder/freecompiler/"> the Borland website </a>. Make sure that it is installed and properly configured. </p> <p> Open an MS-DOS Prompt. Change to the "Borland\freebcc" directory under the SDL source directory. Type "make -f SDL.mak" to build SDL and "make -f SDLmain.mak". There are also makefiles for all of the <a href="#tests">test programs</a>, if you wish to build them. All .exes and DLLs are created in the "test" SDL directory. Ify ou would like to create the DLL and all the test applications, I have thrown together a basic batchfile called "makeall.bat" which should create everything in the right order. </p> <h3> <b> Output files </b> </h3> No matter which compiler you used, three important files should have been produced: <ul> <li> SDL.dll ( Borland format ) </li> <li> SDL.lib ( Borland format ) </li> <li> SDLmain.lib ( Borland format ) </li> </ul> Both of the *.lib files will need to be added to all the projects that use SDL and SDL.dll must be placed some where the Windows dynamic linker can find it (either in your project directory or on the system path, C:\WINDOWS\SYSTEM). <h3> <b><a name="k3"></a> Using Borland C++ Builder for Linux ( AKA Kylix 3 ) </b> </h3> <p> Inside of the "Borland" directory there is a "k3" directory that contains a number of Builder project files. Double-click on the "libSDL.bpg" file icon. Once Builder has started click on the "<u>P</u>rojects" menu on the menu-bar and go down to "B<u>u</u>ild All Projects" option. This will proceed to build all the <a href="#tests">test programs</a>. <br> Linux users do not need *.lib files as the Shared Object is linked right into the project ( very neat actually, Windows should do this sort of thing as it is a lot easier for the developer ). <br> <b>NOTE :</b> The C++ Builder for Windows project format, is not compatible with the Kylix 3 project format, hence the reason why they are in separate directories.</p> <p> On Mandrake 8.1 the shared objects for SDL are located in the /usr/lib directory as libSDL_*.so and the Mesa OpenGL shared objects are located in /usr/X11R6/lib as libGL*.so<br> <br> So if your setup is different you may need to change the project file so that they re-link to the ones on your system.<br> <br> On Mandrake 8.1 the headers files are located at /usr/include/SDL/. So if you you have not installed the development RPMs ( usually named libSDL-devel* ) for SDL ( not included ) you may have to change the include directory within some of the projects.<br> </p> <h3> Known Problems</h3> The only known problem is that I ( Dominique Louis ), was unable to create the projects that rebuilt the SDL shared objects under Linux, due to time constraints and my lack of intimate knowledge of Linux. <h3><a name="tests"><b> Test programs </b> </a></h3> Some of the test programs require included media files ( *.wav; *.bmp etc ). All the test programs are now created in the "test" directory, where the media files are ( usually ) so they should be ready to go. <br> <br> <br> <br> </body> </html>