jyapayne/swig
Watch
1
0
Fork
You've already forked swig
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
swig/Doc/Manual
History
Repository files (latest commit first)
Filename Latest commit message Latest commit date
William S Fulton a8f927dd50 Merge branch 'mzscheme-experimental' 
* mzscheme-experimental:
  Fix mzscheme name and unions testcases
  Terminology correction in html docs
  Suppress experimental language warning when running the test-suite
  Mark MzScheme as an experimental language
  Add mzscheme to Travis testing
  Format mzscheme help output
  Mzscheme out of source examples fixes
  Standardise Mzscheme simple example
  Standardise Guile simple example
  Fix mzscheme static variable wrappers
  MzScheme missing destructor added in, std_vector example fixed
  Fix mzscheme simple example
  Fix mzscheme multimap example
  Skip failing MzScheme tests
2019-02-10 00:50:35 +00:00
..
Allegrocl.html Disable Common Lisp / UFFI target language 2019-02-05 18:41:54 +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 Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Arguments.html Documentation refers to wrong chapter. 2018-10-17 13:00:04 +02:00
CCache.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Disable CFFI Common Lisp target language 2019-02-05 18:42:23 +00:00
Chicken.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Contents.html [OCaml] Add support for the docstring option in the module directive 2019-01-31 15:32:38 -07:00
Contract.html Add C++17 documentation chapter 2018-05-14 21:29:46 +01:00
CPlusPlus11.html Add docs for C++11 ref-qualifiers 2017-08-30 18:17:04 +01:00
CPlusPlus17.html Add missing CPlusPlus17.html file 2018-05-25 07:56:44 +01:00
CSharp.html Fix class having method Connect() creating a name collision with SwigDirectorConnect(). 2018-09-06 12:43:51 +03:00
Customization.html Add C++17 documentation chapter 2018-05-14 21:29:46 +01:00
D.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Doxygen.html Revert "JAVA_HOME nad tools.jar not needed for Java testing" 2018-06-09 00:40:26 +01:00
Extending.html Terminology correction in html docs 2019-02-09 20:32:39 +00:00
fixstyle.py HTML pdf doc generation fixes 2015-12-30 22:22:33 +00:00
Go.html Merge branch 'vadz-doxygen' 2018-06-07 08:13:10 +01:00
Guile.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
index.html Update version number to 4.0 in docs 2017-09-14 07:39:16 +01:00
Introduction.html Add support for differentiating target language statuses 2019-02-04 18:46:16 +00:00
Java.html Merge branch 'vadz-doxygen' 2018-06-07 08:13:10 +01:00
Javascript.html Merge branch 'vadz-doxygen' 2018-06-07 08:13:10 +01:00
Library.html Add C++17 documentation chapter 2018-05-14 21:29:46 +01:00
linkchecker.config html links updates 2015-12-18 21:14:44 +00:00
Lisp.html Disable Allegrcol target language 2019-02-05 18:42:16 +00:00
Lua.html python -> Python in html docs 2018-08-21 22:41:02 +01:00
makechap.py Fixes to makechap.py to detect ill-formed headers 2018-05-25 07:56:44 +01: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 Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Modules.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Mzscheme.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Ocaml.html [OCaml] Add support for the docstring option in the module directive 2019-01-31 15:32:38 -07:00
Octave.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Perl5.html Consistent use of target language version of options 2019-02-05 19:18:46 +00:00
Php.html Merge branch 'vadz-doxygen' 2018-06-07 08:13:10 +01:00
Pike.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Preface.html Add info about the Supported and Experimental language module status 2019-01-29 18:55:44 +00:00
Preprocessor.html Disable CFFI Common Lisp target language 2019-02-05 18:42:23 +00:00
Python.html Improve Python docs on memory management and member variables 2019-01-09 18:24:36 +00:00
R.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Scilab.html HTML chapter numbering updates 2018-06-07 08:16:36 +01:00
Scripting.html Fix some typos in docs and examples and make the code look nicer. 2016-12-31 23:06:56 +08:00
Sections.html Disable CFFI Common Lisp target language 2019-02-05 18:42:23 +00:00
style.css HTML pdf doc generation fixes 2015-12-30 22:22:33 +00:00
SWIG.html Mark MzScheme as an experimental language 2019-02-09 17:58:06 +00:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html python -> Python in html docs 2018-08-21 22:41:02 +01:00
Tcl.html Consistent use of target language version of options 2019-02-05 19:18:46 +00:00
Typemaps.html Typemap %apply docs clarification 2018-10-24 19:53:31 +01:00
Varargs.html Add C++17 documentation chapter 2018-05-14 21:29:46 +01:00
Warnings.html Add support for differentiating target language statuses 2019-02-04 18:46:16 +00:00
Windows.html python -> Python in html docs 2018-08-21 22:41:02 +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>