jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
swig/Doc/Manual
History
Xavier Delacour 458dfd497b Updated bits of the documentation, mostly about the Octave-specific command-line arguments and the module command-line arguments that were added in swig 2.0.4, and the new module-loading behaviour. Also changed example_wrap.cxx to example_wrap.cpp, since mkoctfile doesn't recognise .cxx as a C++ extension. (thanks to Karl Wette) 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12795 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2011-08-31 20:55:12 +00:00
..
Allegrocl.html Fix more doubled word typos 2010-05-23 03:43:31 +00:00
Arguments.html Fix a typo in the documentation (inlne => inline) 2010-06-22 13:02:08 +00:00
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
ch9.table.2.png The great merge 2002-11-30 22:01:28 +00:00
ch11.1.png The great merge 2002-11-30 22:01:28 +00:00
ch11.2.png The great merge 2002-11-30 22:01:28 +00:00
ch11.3.png The great merge 2002-11-30 22:01:28 +00:00
ch12.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Added support for the D programming languge. 2010-11-18 00:24:02 +00:00
Chicken.html Fix numerous broken links reported by linkchecker 2010-03-06 23:23:43 +00:00
Contents.html html fixes 2011-08-04 06:25:45 +00:00
Contract.html Put the chapters back in order after erroneously incorrectly reordering them in last checkin 2008-03-02 22:41:58 +00:00
CSharp.html some doc typo fixes 2011-08-17 21:52:52 +00:00
Customization.html Fix %newobject when used in conjunction with %feature(ref). The code from the ref feature was not always being generated for the function specified by %newobject. Documentation for ref and unref moved from Python to the C++ chapter. 2011-08-23 19:29:10 +00:00
D.html bump version to 2.0.4 2011-03-29 23:01:55 +00:00
Extending.html begin section was missing in some of the docs 2011-05-17 06:38:53 +00:00
fixstyle.py - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Go.html html fixes 2011-08-04 06:25:45 +00:00
Guile.html Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
index.html 1.3 => 2.0 for documentation headings 2010-06-02 22:38:41 +00:00
Introduction.html Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
Java.html some doc typo fixes 2011-08-17 21:52:52 +00:00
Library.html Add in clarification of the memmove function's parameters in the cdata.i library 2011-08-05 06:43:35 +00:00
linkchecker.config Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
Lisp.html Chapter renumbering after adding D chapter 2011-01-07 20:05:44 +00:00
Lua.html SF patch #3394339 from Torsten Landschoff - new option -nomoduleglobal to disable installing the module table into the global namespace. Require call also returns the module table instead of a string 2011-08-22 19:27:56 +00:00
makechap.py SF patch # 3091116 to remove hard coded path to python 2011-01-07 19:57:28 +00:00
Makefile Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
maketoc.py Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
margin-left.patch Update documentation and add margin-left.patch file for htmldoc 2005-03-30 05:55:46 +00:00
Modula3.html Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
Modules.html Use htmldoc's new --overflow option and fix overflow warnings in the pdf documentation generation 2011-01-08 01:28:09 +00:00
Mzscheme.html Add mzscheme tip from bug #2942899 2011-02-05 15:45:36 +00:00
Ocaml.html Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
Octave.html Updated bits of the documentation, mostly about the Octave-specific command-line arguments and the module command-line arguments that were added in swig 2.0.4, and the new module-loading behaviour. Also changed example_wrap.cxx to example_wrap.cpp, since mkoctfile doesn't recognise .cxx as a C++ extension. (thanks to Karl Wette) 2011-08-31 20:55:12 +00:00
Perl5.html Update supported Perl versions to more closely reflect reality. 2011-06-18 04:33:00 +00:00
Php.html Section numbering update 2011-08-04 06:23:24 +00:00
Pike.html Chapter renumbering after adding D chapter 2011-01-07 20:05:44 +00:00
Preface.html html fixes and chapter renumbering 2010-06-01 19:19:17 +00:00
Preprocessor.html clarification on SWIG_VERSION coding 2010-05-14 06:14:18 +00:00
Python.html Fix %newobject when used in conjunction with %feature(ref). The code from the ref feature was not always being generated for the function specified by %newobject. Documentation for ref and unref moved from Python to the C++ chapter. 2011-08-23 19:29:10 +00:00
R.html Chapter renumbering after adding D chapter 2011-01-07 20:05:44 +00:00
README - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Ruby.html Chapter renumbering after adding D chapter 2011-01-07 20:05:44 +00:00
Scripting.html Put the chapters back in order after erroneously incorrectly reordering them in last checkin 2008-03-02 22:41:58 +00:00
Sections.html bump version to 2.0.5 2011-05-21 22:33:36 +00:00
style.css Remove non-existent html tag 2006-07-08 00:52:51 +00:00
SWIG.html begin section was missing in some of the docs 2011-05-17 06:38:53 +00:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Fix %newobject when used in conjunction with %feature(ref). The code from the ref feature was not always being generated for the function specified by %newobject. Documentation for ref and unref moved from Python to the C++ chapter. 2011-08-23 19:29:10 +00:00
Tcl.html Chapter renumbering after adding D chapter 2011-01-07 20:05:44 +00:00
Typemaps.html Use htmldoc's new --overflow option and fix overflow warnings in the pdf documentation generation 2011-01-08 01:28:09 +00:00
Varargs.html Remove VARARGS_SENTINEL typemaps further to revision 12666. Note that the idea of having a named typemap for sentinels is flawed unless the named typemap is provided for every single type in the typemap library. 2011-05-14 23:54:09 +00:00
Warnings.html Change preprocessing error for tokens appearing after #else and #end to warning. Add some missing warning documentation and a couple of warning messages tidy up. 2011-02-17 21:54:13 +00:00
Windows.html Update docs for first 2.0 release 2010-05-28 23:53: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 is generated automatically by the 'maketoc.py'
script. The Makefile has further information on how the various alternative
forms of the documentation is 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>