jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
swig/Doc/Manual
History
Olly Betts f4d8a7f78b PHP now generates E_NOTICE for misspelled constant
2016-11-30 13:07:17 +13:00
..
Allegrocl.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
android-class.png Add Android docs - supporting screenshots 2011-12-10 17:03:50 +00:00
android-simple.png Add Android docs - supporting screenshots 2011-12-10 17:03:50 +00:00
Android.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Arguments.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
CCache.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Add Scilab to html docs 2015-01-27 19:30:24 +00:00
Chicken.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Contents.html Add support for "ret" typemap where missing and improve documentation on it. 2016-09-29 08:07:26 +01:00
Contract.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
CPlusPlus11.html C++11 alias templates doc and changes file update 2016-11-02 10:05:39 +00:00
CSharp.html Update C# compilers 2016-11-25 18:55:52 +00:00
Customization.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
D.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Extending.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
fixstyle.py HTML pdf doc generation fixes 2015-12-30 22:22:33 +00:00
Go.html Merge pull request #542 from Sajmani/master 2016-03-31 13:07:31 +13:00
Guile.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
index.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Introduction.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Java.html Java doc update for directorin typemaps and Swig::LocalRefGuard 2016-11-03 19:23:29 +00:00
Javascript.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Library.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
linkchecker.config html links updates 2015-12-18 21:14:44 +00:00
Lisp.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Lua.html Update documentation for using SWIG_ConvertPtr example usage 2016-10-23 20:16:35 +01:00
makechap.py Correct html documentation linking generated by makechap.py script 2015-12-30 22:22:31 +00:00
Makefile Fix outdated info in Doc Makefile about pdf file generation 2016-11-25 07:39:06 +00:00
maketoc.py HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Modula3.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Modules.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Mzscheme.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Ocaml.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Octave.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Perl5.html Update documentation for using SWIG_ConvertPtr example usage 2016-10-23 20:16:35 +01:00
Php.html PHP now generates E_NOTICE for misspelled constant 2016-11-30 13:07:17 +13:00
Pike.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Preface.html html doc fixes 2016-04-02 13:47:23 +01:00
Preprocessor.html [PHP] Add support for PHP7. 2016-11-30 13:05:59 +13:00
Python.html Update documentation for using SWIG_ConvertPtr example usage 2016-10-23 20:16:35 +01:00
R.html HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html fix typo 2016-01-12 19:52:40 +09:00
Scilab.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Scripting.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00
Sections.html Bump version to 3.0.11 2016-06-12 10:14:11 +01:00
style.css HTML pdf doc generation fixes 2015-12-30 22:22:33 +00:00
SWIG.html [PHP] Add support for PHP7. 2016-11-30 13:05:59 +13:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html html fix 2016-11-03 19:26:38 +00:00
Tcl.html Update documentation for using SWIG_ConvertPtr example usage 2016-10-23 20:16:35 +01:00
Typemaps.html Update documentation for using SWIG_ConvertPtr example usage 2016-10-23 20:16:35 +01:00
Varargs.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Warnings.html Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Windows.html Replace tabs with spaces in html docs 2015-12-30 22:22:33 +00:00

README 

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 are generated automatically by the 'maketoc.py'
script. The Makefile has further information on how the various alternative
forms of the documentation are 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>