swig/Doc/Manual
William S Fulton cebbfef29d feature doc refinement
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk/SWIG@9193 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2006-07-04 21:13:21 +00:00
..
.cvsignore no message 2004-10-27 21:32:19 +00:00
Allegrocl.html 04/05/2006: mutandiz 2006-04-06 06:28:53 +00:00
Arguments.html fix extern declarations documentation 2005-06-28 21:32:46 +00:00
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
ch9.table.2.png The great merge 2002-11-30 22:01:28 +00:00
ch11.1.png The great merge 2002-11-30 22:01:28 +00:00
ch11.2.png The great merge 2002-11-30 22:01:28 +00:00
ch11.3.png The great merge 2002-11-30 22:01:28 +00:00
ch12.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Committing R-SWIG 2006-06-29 03:01:18 +00:00
Chicken.html Remove integers_runme.ss because Chicken does not test for integer overflow 2006-06-21 04:16:21 +00:00
Contents.html link updates 2006-06-05 21:07:17 +00:00
Contract.html html validation fixes 2005-06-03 23:06:56 +00:00
CSharp.html link updates 2006-06-05 21:07:17 +00:00
Customization.html feature doc refinement 2006-07-04 21:13:21 +00:00
Extending.html Fix typos, html errors and add new section on prerequisites for adding new language modules to swig distribution 2006-02-14 19:59:43 +00:00
fixstyle.py - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Guile.html Update after runnning make - chapter numbers have changed 2005-11-26 22:57:21 +00:00
index.html Thousands of changes to correct incorrect HTML. HTML is now valid (transitional 4.01). 2004-08-04 21:28:14 +00:00
Introduction.html fix extern declarations documentation 2005-06-28 21:32:46 +00:00
Java.html Add notes about strict aliasing rules 2006-03-04 23:41:02 +00:00
Library.html html fixes 2005-12-22 23:31:02 +00:00
Lisp.html Fix html errors, reported when running make 2005-11-26 23:26:04 +00:00
Lua.html html fixes 2006-03-04 23:43:20 +00:00
makechap.py allegrocl: add Doc/Manual/Allegrocl.html, which was missing from last commit. 2005-11-14 18:28:27 +00:00
Makefile add details about htmldoc patch 2005-09-29 20:18:21 +00:00
maketoc.py missing DOCTYPE 2004-09-10 22:27:52 +00:00
margin-left.patch Update documentation and add margin-left.patch file for htmldoc 2005-03-30 05:55:46 +00:00
Modula3.html Update after runnning make - chapter numbers have changed 2005-11-26 22:57:21 +00:00
Modules.html Typo fixes. 2006-05-20 09:03:29 +00:00
Mzscheme.html Remove old style typemap declarations 2005-12-16 21:43:22 +00:00
Ocaml.html Update after runnning make - chapter numbers have changed 2005-11-26 22:57:21 +00:00
Perl5.html update after running tool checkers 2006-01-09 21:34:29 +00:00
Php.html Remove reference to -dlname. 2006-05-20 04:56:19 +00:00
Pike.html Update after runnning make - chapter numbers have changed 2005-11-26 22:57:21 +00:00
Preface.html update mailing list names 2006-01-02 00:20:36 +00:00
Preprocessor.html update after running tool checkers 2006-01-09 21:34:29 +00:00
Python.html Fix some typos. 2006-05-21 11:13:33 +00:00
R.html Committing R-SWIG 2006-06-29 03:01:18 +00:00
README - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Ruby.html Significant rearrangment of some sections of the documentaiton. Also added additional information about exception handling and getter/setter methods. 2006-02-02 10:57:37 +00:00
Scripting.html html validation fixes 2005-06-03 23:06:56 +00:00
Sections.html 1.3.29 date change 2006-03-20 23:55:17 +00:00
style.css - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
SWIG.html Nested class workarounds added 2006-06-13 19:27:44 +00:00
swig16.png swig logo file for the docs 2004-08-04 21:41:35 +00:00
SWIGPlus.html Overhaul updating to what SWIG really does - ie more emphasis on proxy classes over the low level accessor functions 2006-06-29 21:18:33 +00:00
Tcl.html Update after runnning make - chapter numbers have changed 2005-11-26 22:57:21 +00:00
Typemaps.html Fix typos 2006-05-20 05:58:26 +00:00
Varargs.html html validation fixes 2005-06-03 23:06:56 +00:00
Warnings.html Portability warning for files which will overwrite each other on case insensitive file systems such as FAT32/NTFS. 2005-11-09 22:57:57 +00:00
Windows.html html fixes 2006-02-12 01:27:20 +00:00

This directory contains the HTML for the SWIG users manual.

All of this HTML is hand-written.  However, section numbering, indices,
and the table of contents is generated automatically by the 'maketoc.py'
script. The Makefile has further information on how the various alternative
forms of the documentation is generated from the hand-written HTML.

There are 4 types of boxes that code or whatever can be inside:
  - <div class="shell">...</div>
    This is for text that shows the output of running commands on the shell.
  - <div class="code">...</div>
    This is for either C, C++, or SWIG code
  - <div class="targetlang">...</div>
    This is for code in a target scripting language
  - <div class="diagram">...</div>
    This is for text that is not code or a shell

The general format is
<div class="foo"><pre>
whatever here
</pre></div>