jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
swig/Doc/Manual
History
Michael Schaller a17c9727bd Fleshed out Go's documentation about the director feature and added a director example. 
Fixes issues #418.
2015-08-04 09:34:26 +02:00
..
Allegrocl.html html fixes and section updates 2014-03-15 22:45:43 +00: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 Typo fix in Android docs 2014-09-30 20:29:17 +01:00
Arguments.html html fixes and section updates 2014-03-15 22:45:43 +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 html fixes and section updates 2014-03-15 22:45:43 +00:00
Contents.html Cosmetic corrections - Mac OS X 2015-08-02 20:14:20 +01:00
Contract.html html fixes and section updates 2014-03-15 22:45:43 +00:00
CPlusPlus11.html Document new C++11 strongly typed enumerations support. 2014-12-07 17:10:07 +00:00
CSharp.html Html doc fixes 2015-07-05 17:16:37 +01:00
Customization.html Consistently put whitespace outside of <tt>...</tt> and not inside 2014-11-18 12:44:37 +13:00
D.html html fixes and section updates 2014-03-15 22:45:43 +00:00
Extending.html Add Scilab to html docs 2015-01-27 19:30:24 +00:00
fixstyle.py - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Go.html Fleshed out Go's documentation about the director feature and added a director example. 2015-08-04 09:34:26 +02:00
Guile.html html fixes and section updates 2014-03-15 22:45:43 +00:00
index.html SWIG 3 doc updates 2014-03-16 21:49:54 +00:00
Introduction.html Expand section on code generation philosophy. 2015-06-11 20:13:09 +01:00
Java.html Fix potential security exploit in generated Java classes 2015-08-02 11:22:46 +01:00
Javascript.html Cosmetic corrections - Mac OS X 2015-08-02 20:14:20 +01:00
Library.html Update docs wrt directors and shared_ptr 2015-05-14 19:26:55 +01:00
linkchecker.config Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
Lisp.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Lua.html Fix random case flipping of an HTML source line 2015-03-16 18:02:03 +13:00
makechap.py SF patch # 3091116 to remove hard coded path to python 2011-01-07 19:57:28 +00:00
Makefile Whitespace cleanup of all Makefiles* 2014-05-02 20:06:11 +02:00
maketoc.py Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
margin-left.patch Update htmldoc patch to htmldoc-1.8.27 2013-05-12 19:14:58 +01:00
Modula3.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Modules.html -external-runtime doc improvement 2015-06-16 19:53:09 +01:00
Mzscheme.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Ocaml.html Whitespace cleanup 2015-03-19 13:15:23 +13:00
Octave.html Update CHANGES.current and Octave.html to indicate Octave 4.0.0 support 2015-07-17 09:49:44 +02:00
Perl5.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Php.html HTML tweaks 2014-12-29 21:54:58 +00:00
Pike.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Preface.html Move installation and install check instructions from README to Preface section in the documentation. 2013-05-03 19:55:42 +01:00
Preprocessor.html Merge branch 'master' into gsoc2012-scilab 2014-06-06 16:33:16 +02:00
Python.html Html doc fixes 2015-07-05 17:16:37 +01:00
R.html Added some information on manually compiling for R 2015-03-10 10:07:05 -06:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html Fix typo 2015-01-14 11:04:09 +13:00
Scilab.html scilab: fix doc typos 2015-03-24 16:52:18 +01:00
Scripting.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13:00
Sections.html Bump version to 3.0.8 2015-08-03 22:33:52 +01:00
style.css Revert css style changes in javascript branch 2014-04-16 07:59:24 +01:00
SWIG.html Documentation improvements for -o and -oh options 2015-06-12 06:32:58 +01:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Clearer warning message for badly constructed typecheck typemaps 2015-04-14 07:34:40 +01:00
Tcl.html Add Scilab to html docs 2015-01-27 19:30:24 +00:00
Typemaps.html HTML fix in docs 2015-08-02 19:47:02 +01:00
Varargs.html html fixes and section updates 2014-03-15 22:45:43 +00:00
Warnings.html Clearer warning message for badly constructed typecheck typemaps 2015-04-14 07:34:40 +01:00
Windows.html Expand __declspec documentation 2015-04-14 08:13:13 +01: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>