jyapayne/swig
Watch
1
0
Fork
You've already forked swig
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
swig/Doc/Manual
History
Repository files (latest commit first)
Filename Latest commit message Latest commit date
John McFarland ae70993380 Update documentation for doxygen tags 
Updates to supported/unsupported doxygen tags for both Java and
Python.  Document new support for \code and \param options.  Also
update documentation of various other tags as well as the list of
unsupported tags for python.
2019-09-15 10:59:03 -05:00
..
Allegrocl.html Disable Common Lisp / UFFI target language 2019-02-05 18:41:54 +00: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 Correct out of date html links 2019-04-15 19:01:52 +01:00
Arguments.html Documentation section numbering update 2019-02-11 19:02:03 +00:00
CCache.html Correct out of date html links 2019-04-15 19:01:52 +01:00
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Add a documentation chapter on C++14 2019-02-11 18:59:46 +00:00
Chicken.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Contents.html HTML section numbering update 2019-04-24 08:06:10 +01:00
Contract.html Documentation section numbering update 2019-02-11 19:02:03 +00:00
CPlusPlus11.html html section numbers updated 2019-02-10 17:40:00 +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
CSharp.html Correct out of date html links 2019-04-15 19:01:52 +01:00
Customization.html Documentation section numbering update 2019-02-11 19:02:03 +00:00
D.html Documentation: terminology consistency for command line options plus Doxygen tweaks. 2019-04-24 08:04:15 +01:00
Doxygen.html Update documentation for doxygen tags 2019-09-15 10:59:03 -05:00
Extending.html Misc. documentation and source comment typo fixes 2019-05-28 11:41:22 +12:00
fixstyle.py HTML pdf doc generation fixes 2015-12-30 22:22:33 +00:00
Go.html Misc. documentation and source comment typo fixes 2019-05-28 11:41:22 +12:00
Guile.html Documentation section numbering update 2019-02-11 19:02:03 +00:00
index.html Update version number to 4.0 in docs 2017-09-14 07:39:16 +01:00
Introduction.html Clear up some confusion over ANSI vs ISO C/C++ support 2019-04-18 20:04:20 +01:00
Java.html Documentation: terminology consistency for command line options plus Doxygen tweaks. 2019-04-24 08:04:15 +01:00
Javascript.html Add linkchecker3 make target to check internal links 2019-04-15 19:31:32 +01:00
Library.html Remove use of std::bind2nd which is removed in C++17 2019-06-27 07:40:49 +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 Clear up some confusion over ANSI vs ISO C/C++ support 2019-04-18 20:04:20 +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
Modula3.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Modules.html Documentation section numbering update 2019-02-11 19:02:03 +00:00
Mzscheme.html Correct out of date html links 2019-04-15 19:01:52 +01:00
Ocaml.html [OCaml] Some documentation improvements for %exception 2019-02-12 19:43:55 -07:00
Octave.html Update section numbering 2019-02-10 01:03:06 +00:00
Perl5.html Documentation for directors and virtual final methods 2019-03-03 14:52:57 +00:00
Php.html [php] Update docs about undefined constants 2019-05-22 11:13:55 +12:00
Pike.html Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
Preface.html Add info about the Supported and Experimental language module status 2019-01-29 18:55:44 +00:00
Preprocessor.html Documentation: terminology consistency for command line options plus Doxygen tweaks. 2019-04-24 08:04:15 +01:00
Python.html Misc. documentation and source comment typo fixes 2019-05-28 11:41:22 +12:00
R.html html documentation fixes 2019-04-08 19:20:50 +01:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html Ruby 1.9 and later testing on Travis xenial 2019-05-24 19:30:47 +01:00
Scilab.html Correct out of date html links 2019-04-15 19:01:52 +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.0.1 2019-04-28 21:01:21 +01:00
style.css Reformat tag lists in doxygen documentation 2019-09-15 10:57:58 -05:00
SWIG.html Correct %init documentation for C#/Java 2019-07-30 21:12:04 +02:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Clear up some confusion over ANSI vs ISO C/C++ support 2019-04-18 20:04:20 +01:00
Tcl.html Update section numbering 2019-02-10 01:03:06 +00:00
Typemaps.html Update docs on %typecheck precedence levels 2019-07-25 18:57:10 +01:00
Varargs.html Documentation section numbering update 2019-02-11 19:02:03 +00:00
Warnings.html Warning tweaks for destructors that are final in director classes 2019-03-03 15:12:29 +00:00
Windows.html Windows documentation minor improvement 2019-05-04 22:28:35 +01: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>