swig/Doc/Manual
William S Fulton ef0bbcd6ed Document Python stable ABI support
Remove -stable-abi option: going forwards enabling the stable ABI
simply requires setting Py_LIMITED_ABI when compiling the wrappers.
2023-12-18 23:30:36 +00:00
..
Android.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Arguments.html Remove deprecated BOTH typemap rule 2023-06-15 15:07:04 +12:00
CCache.html Use https for swig.org links 2022-10-06 13:16:39 +13:00
CPlusPlus11.html Update type inference documentation 2023-11-30 17:56:00 +13:00
CPlusPlus14.html HTML fixes 2023-06-28 19:37:22 +01:00
CPlusPlus17.html Add support for C++17 hexadecimal floating literals 2019-02-13 15:16:40 -07:00
CPlusPlus20.html Add support for C++20 constexpr destructors 2023-11-24 20:12:02 +00:00
CSharp.html Fix typos in comments and docs 2023-11-30 17:07:16 +13:00
Contents.html Document Python stable ABI support 2023-12-18 23:30:36 +00:00
Contract.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Customization.html Remove long deprecated features 2023-06-15 15:05:15 +12:00
D.html Add csbegin, dbegin, javabegin for %module 2023-11-06 19:12:35 +00:00
Doxygen.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Extending.html Language module sections clarification 2023-08-23 08:03:13 +01:00
Go.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Guile.html [Guile] Drop support for -Linkage ltdlmod 2023-06-16 09:28:20 +12:00
Introduction.html Language module sections clarification 2023-08-23 08:03:13 +01:00
Java.html Add csbegin, dbegin, javabegin for %module 2023-11-06 19:12:35 +00:00
Javascript.html Fix minor typos in manual 2023-10-16 11:11:21 +13:00
Library.html Fix minor typos in manual 2023-10-16 11:11:21 +13:00
Lua.html Fix typos in comments and docs 2023-11-30 17:07:16 +13:00
Makefile Allow wkhtmltopdf to access current directory 2022-10-15 00:28:04 +01:00
Modules.html Fix module example so generated code compiles 2022-03-18 19:26:16 +13:00
Mzscheme.html [mzscheme] Document lack of support for Racket 8 2023-05-29 18:09:23 +12:00
Ocaml.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Octave.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Perl5.html Remove long deprecated features 2023-06-15 15:05:15 +12:00
Php.html Remove support for PHP7 2023-04-14 17:38:01 +12:00
Preface.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Preprocessor.html Support -std= command line option 2023-11-09 12:27:44 +13:00
Python.html Document Python stable ABI support 2023-12-18 23:30:36 +00:00
R.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html [doc] Update "known to work" for Ruby 2023-10-16 10:17:48 +13:00
SWIG.html [Tcl] Migrate `CONST` to `const` 2023-11-15 06:28:26 -06:00
SWIGPlus.html Add support for C++11 using declarations for inheriting constructors 2023-07-04 12:07:16 +01:00
Scilab.html HTML fixes 2023-06-28 19:37:22 +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 Bump version to 4.2.0 and migrate CHANGES to CHANGES.current 2022-11-04 20:09:13 +00:00
Tcl.html [Tcl] Remove docs for CONSTANT typemaps 2023-11-10 15:58:19 +13:00
Typemaps.html Clean up after removal of ignore typemaps 2023-06-15 16:22:31 +12:00
Varargs.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Warnings.html Reword and simplify warnings 302 and 322 2023-07-28 07:16:49 +01:00
Windows.html HTML fixes 2023-06-28 19:37:22 +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
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
fixstyle.py HTML pdf doc generation fixes 2015-12-30 22:22:33 +00:00
index.html Bump doc version to SWIG-4.1 2022-10-15 00:28:09 +01:00
linkchecker.config html links updates 2015-12-18 21:14:44 +00:00
makechap.py Update python manual scripts to py3 compatibility (#2204) 2022-03-18 13:29:22 +13:00
maketoc.py Update python manual scripts to py3 compatibility (#2204) 2022-03-18 13:29:22 +13:00
style.css Reformat tag lists in doxygen documentation 2019-09-15 10:57:58 -05:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +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>