swig/Doc/Manual
Olly Betts 9c16ce8ab3 [ocaml] Improve the Qt example
Drop a method which has been deprecated then removed in Qt (but isn't
actually used in the example anyway) and clean up the steps a bit.

The example still doesn't build for me as the final step fails with:

File "_none_", line 1:
Error: Module `Dynlink' is unavailable (required by `Camlp4')

I know next to nothing about ocaml, so that may be something I've
failed to install, but I couldn't work out what.  I think the Qt
library linking needs updating too - there doesn't seem to be a
single `-lqt` now, but I don't use Qt either.
2022-02-01 11:46:39 +13: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
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 Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Contents.html Move docs on replacing c++ class methods to C++ section 2022-01-27 21:25:35 +00:00
Contract.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
CPlusPlus11.html Extern template tweaks 2022-01-25 00:28:08 +00: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 [js] Update docs re v8 support 2021-12-02 14:01:27 +13: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 [ocaml] Improve the Qt example 2022-02-01 11:46:39 +13:00
Octave.html Fix missing HTML escaping in Octave docs 2022-01-18 13:56:07 +13:00
Perl5.html [perl] Require at least Perl 5.8.0 2022-01-19 10:07:30 +13:00
Php.html HTML formatting fixes 2022-01-27 20:39:04 +00:00
Preface.html Few more PCRE to PCRE2 changes 2022-01-21 18:35:20 +00:00
Preprocessor.html Clarify what SWIGPHP7 means 2021-03-21 10:43:06 +13:00
Python.html [python] Fix double free on error in docs example 2022-01-26 13:30:15 +13: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 Remove redundant NULL checks before free()/delete (#2184) 2022-01-29 22:03:48 +13:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Move docs on replacing c++ class methods to C++ section 2022-01-27 21:25:35 +00:00
Tcl.html Remove redundant NULL checks before free()/delete (#2184) 2022-01-29 22:03:48 +13:00
Typemaps.html Remove redundant NULL checks before free()/delete (#2184) 2022-01-29 22:03:48 +13:00
Varargs.html Add C++20 documentation chapter 2020-06-08 20:56:40 +01:00
Warnings.html Extern template tweaks 2022-01-25 00:28:08 +00:00
Windows.html Update CMake build to use NuGet Bison3 2022-01-29 09:19:04 +13: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>