swig/Doc/Manual
Vadim Zeitlin 8d9f3e88b2 Expand special variables in cxxcode typemap
This makes the typemap much more useful, as it can now reference the
name of the class it is being expanded for and the type of the C pointer
used by it (in principle, the latter could be recovered by using
decltype(), but this results in rather verbose code inside static
methods where a dummy pointer to the type must be constructed first, so
using another special variable seems like a simpler solution).
2021-12-07 20:54:28 +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 Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Arguments.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
C.html Expand special variables in cxxcode typemap 2021-12-07 20:54:28 +01:00
CCache.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Merge branch 'master' into C 2021-10-04 16:03:36 +02:00
Contents.html Added windows build instructions for MSYS2 2021-03-19 22:31:32 +00:00
Contract.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
CPlusPlus11.html Document lack of support for auto for C++ variables (#1125) 2021-01-19 10:03:56 +13:00
CPlusPlus14.html Documentation section numbering update 2019-02-11 19:02:03 +00:00
CPlusPlus17.html Add support for C++17 hexadecimal floating literals 2019-02-13 15:16:40 -07:00
CPlusPlus20.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
CSharp.html Add access modifier support for interface feature 2020-09-25 18:54:25 +01:00
Customization.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
D.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Doxygen.html Fix typos 2021-11-17 07:07:02 +02:00
Extending.html Update CI system wrt experimental languages 2021-11-17 22:18:06 +00:00
fixstyle.py HTML pdf doc generation fixes 2015-12-30 22:22:33 +00:00
Go.html remove Go -no-cgo option 2021-09-14 13:59:21 -07:00
Guile.html Fix more "allows to" and other typos 2021-04-21 15:54:46 +12:00
index.html Update version number to 4.0 in docs 2017-09-14 07:39:16 +01:00
Introduction.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Java.html Fix typos 2021-11-17 07:07:02 +02:00
Javascript.html Fix more "allows to" and other typos 2021-04-21 15:54:46 +12:00
Library.html Add C++20 documentation chapter 2020-06-08 20:56:40 +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 Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
makechap.py Fixes to makechap.py to detect ill-formed headers 2018-05-25 07:56:44 +01:00
Makefile Add linkchecker3 make target to check internal links 2019-04-15 19:31:32 +01:00
maketoc.py HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
Modules.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Mzscheme.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Ocaml.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Octave.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Perl5.html Remove support for $source and $target 2021-04-30 10:20:14 +12:00
Php.html Update PHP docs for recent changes 2021-05-06 16:02:37 +12:00
Preface.html Add info about the Supported and Experimental language module status 2019-01-29 18:55:44 +00:00
Preprocessor.html Clarify what SWIGPHP7 means 2021-03-21 10:43:06 +13:00
Python.html Update docs - python static members access 2021-10-20 11:53:18 +01:00
R.html Fix typos 2021-11-17 07:07:02 +02:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Scilab.html Add C++20 documentation chapter 2020-06-08 20:56:40 +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 Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
style.css Reformat tag lists in doxygen documentation 2019-09-15 10:57:58 -05:00
SWIG.html Fix more "allows to" and other typos 2021-04-21 15:54:46 +12:00
swig16.png Revert rev 11187 "Merged with recent changes from trunk." 2012-05-06 01:13:16 +00:00
SWIGPlus.html Fix "dobule" typos in docs 2021-07-06 10:56:48 +12:00
Tcl.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Typemaps.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Varargs.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Warnings.html Remove support for $source and $target 2021-04-30 10:20:14 +12:00
Windows.html [CMake] Add option to enable pcre 2021-10-03 16:32:11 +02: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 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>