swig/Doc/Manual
William S Fulton 7c478b5e17 Note the LENGTH STRING typemap changes and tidy up 2025-07-28 23:02:52 +01: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
C.html C chapter added, HTML corrections 2024-09-16 19:51:37 +01:00
CCache.html Use https for swig.org links 2022-10-06 13:16:39 +13:00
CPlusPlus11.html Fix typo in manual 2024-09-28 15:08:05 +12:00
CPlusPlus14.html Handle C++14 auto return type function declaraction 2025-05-28 14:10:03 +12:00
CPlusPlus17.html Support C++17 fold expressions 2024-05-15 11:10:00 +12:00
CPlusPlus20.html Support __VA_OPT__ 2024-03-28 12:46:58 +13:00
CSharp.html Correct docs for libraries requiring .NET 4 2024-11-26 19:36:25 +00:00
Contents.html Documentation heading updates 2025-05-13 22:25:20 +01:00
Contract.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Customization.html Add $isvoid special variable 2024-06-15 23:13:12 +01:00
D.html cdata doc updates 2024-06-07 08:27:15 +01:00
Doxygen.html Doxygen docs minor tweaks 2024-09-19 19:51:16 +01:00
Extending.html Update manual section numbers 2025-04-01 14:05:28 +13:00
Go.html [Go] Use unsafe.Slice and unsafe.String in Go fragments 2025-06-25 13:55:43 -07:00
Guile.html C chapter added, HTML corrections 2024-09-16 19:51:37 +01:00
Introduction.html Formalise the deprecation of target languages with a Deprecation status 2024-09-27 19:42:16 +01:00
Java.html Correct some docs about javapackage 2025-06-28 16:09:06 +01:00
Javascript.html Formalise the deprecation of target languages with a Deprecation status 2024-09-27 19:42:16 +01:00
Library.html Note the LENGTH STRING typemap changes and tidy up 2025-07-28 23:02:52 +01:00
Lua.html Add docs for %nspacemove 2024-06-01 13:41:51 +01:00
Makefile Python shebang modernisation for python3 2024-09-22 22:11:33 +01:00
Modules.html Fix module example so generated code compiles 2022-03-18 19:26:16 +13:00
Ocaml.html Update manual section numbers 2025-04-01 14:05:28 +13:00
Octave.html html fixes 2024-02-23 23:57:14 +00:00
Perl5.html Remove long deprecated features 2023-06-15 15:05:15 +12:00
Php.html Update PHP compilation example 2024-07-26 08:34:02 +12:00
Preface.html Updates and corrections in the Preface chapter 2024-10-15 08:59:51 +01:00
Preprocessor.html Add -nogil opt-in flag to remove need for PYTHON_GIL=0 2025-07-18 22:41:36 +01:00
Python.html Add -nogil opt-in flag to remove need for PYTHON_GIL=0 2025-07-18 22:41:36 +01: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 Add $isvoid special variable expansion for directors 2024-10-06 15:00:37 +01:00
SWIG.html [MzScheme/Racket] Drop support 2025-04-01 14:05:28 +13:00
SWIGPlus.html Remove remains of %nestedworkaround 2024-09-12 14:41:24 +12:00
Scilab.html Adjust oldest supported scilab version 2024-09-18 13:39:03 +12:00
Scripting.html Suggest -fPIC instead of -fpic 2024-07-26 08:34:02 +12:00
Sections.html HTML correction - release is in progress 2025-04-15 23:04:24 +01:00
Tcl.html Update docs for Tcl 9.0 changes 2024-01-12 14:13:24 +13:00
Typemaps.html Enhance docs for copying typemaps using 2025-04-25 07:53:58 +01:00
Varargs.html Py_DecRef Py_IncRef for examples and html docs 2024-03-24 18:12:21 +00:00
Warnings.html More maintainable warning messages 2024-10-06 12:28:17 +01:00
Windows.html HTML updates 2024-10-20 17:16:08 +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 [MzScheme/Racket] Drop support 2025-04-01 14:05:28 +13:00
fixstyle.py Python shebang modernisation for python3 2024-09-22 22:11:33 +01:00
index.html Drop version number from index.html 2023-12-30 23:04:02 +00:00
linkchecker.config html links updates 2015-12-18 21:14:44 +00:00
makechap.py Python shebang modernisation for python3 2024-09-22 22:11:33 +01:00
maketoc.py Documentation generation fix and update to changes file 2024-10-07 20:10:14 +01:00
style.css Reformat tag lists in doxygen documentation 2019-09-15 10:57:58 -05:00
swig16.png Revert rev 11187 "Merged with recent changes from trunk." 2012-05-06 01:13:16 +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>