XS-MLVP
/
swig
mirror of https://github.com/swig/swig.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
swig/Doc/Manual
History
Olly Betts a6041462fc Eliminate docs implying free() doesn't accept NULL 
This may have been true for some pre-ISO C implementations, but
ISO C (which came out as ANSI C in 1989) requires free() accept NULL
so let's not perpetuate information that's been out of date for
decades.
 		2023-05-21 10:16:06 +12:00
..
Android.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Arguments.html Eliminate docs implying free() doesn't accept NULL 2023-05-21 10:16:06 +12:00
CCache.html Use https for swig.org links 2022-10-06 13:16:39 +13:00
CPlusPlus11.html Support deducing decltype for false and true 2023-05-20 09:09:48 +12:00
CPlusPlus14.html Correct to standard approach to mentioning SWIG version info in docs 2023-05-20 09:52:54 +01:00
CPlusPlus17.html Add support for C++17 hexadecimal floating literals 2019-02-13 15:16:40 -07:00
CPlusPlus20.html html corrections 2022-07-30 17:42:44 +01:00
CSharp.html C#: Add missing explicit `global::System` in manual 2023-04-21 09:48:30 +12:00
Contents.html Initial support for std::string_view 2023-05-08 15:56:37 +12:00
Contract.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Customization.html Cosmetic stray semi-colon removal after %typemap using quotes 2022-08-31 19:40:13 +01:00
D.html Fix typo ('not' -> 'now') 2023-05-20 15:22:26 +12:00
Doxygen.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Extending.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Go.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Guile.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Introduction.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Java.html Cosmetic stray semi-colon removal after %typemap using quotes 2022-08-31 19:40:13 +01:00
Javascript.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Library.html Initial support for std::string_view 2023-05-08 15:56:37 +12:00
Lua.html Fix doc typos 2022-10-11 10:30:33 +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 Add C++20 documentation chapter 2020-06-08 20:56:40 +01: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 Use https for swig.org links 2022-10-06 13:16:39 +13: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 Define __STDC__ to 1 rather than an empty value 2023-05-18 12:45:31 +12:00
Python.html Add %rename to %pythoncode example 2023-05-15 11:09:13 +12: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] Fix SWIG_AsCharPtrAndSize arg types 2023-05-09 14:06:46 +12:00
SWIG.html Add new -U command line option 2023-05-18 12:45:31 +12:00
SWIGPlus.html Merge branch 'rtests2' 2022-11-23 21:12:07 +00:00
Scilab.html scilab: add a gateway xml v6 with full function names 2023-04-20 07:34:19 +12: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 Clean up Tcl version docs and handling 2022-07-28 14:30:43 +12:00
Typemaps.html Cosmetic stray semi-colon removal after %typemap using quotes 2022-08-31 19:40:13 +01:00
Varargs.html Use https for links in docs where supported 2022-10-06 13:41:21 +13:00
Warnings.html Partial support for auto without trailing return type 2023-05-18 15:19:23 +12:00
Windows.html html fixes 2022-10-14 08:45:38 +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>