jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
swig/Doc/Manual
History
William S Fulton b9b9b3cd21 Merge master and C++11 strongly typed enum support 
Merging from master:
* 'master' of github.com:/swig/swig:
  Add more docs about _global_ prefix in typemap temporary variables
  Add clarification on _global_ prefix.
  fix for nested template defined out of class (issue #265)
  using an unknown constant emits a notice, not a warning
  Fix typo
  Consistently put whitespace outside of <tt>...</tt> and not inside
  wording tweak
  Go: Document memory management of C++ classes allocated in Go.  Fixes #266.
  revert unrelated file
  Fix #224
  Fixes for clang -fsanitize=undefined-trap -fsanitize-undefined-trap-on-error
  delete unmeaningful macro
  Go: fix overload functions with polymorphic issue
  del tmp files
  GoLang:fix overload functions with polymorphic issue
2014-12-07 17:33:16 +00:00
..
Allegrocl.html html fixes and section updates 2014-03-15 22:45:43 +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 Typo fix in Android docs 2014-09-30 20:29:17 +01:00
Arguments.html html fixes and section updates 2014-03-15 22:45:43 +00:00
ch2.1.png The great merge 2002-11-30 22:01:28 +00:00
chapters Merge branch 'master' into tmp 2014-03-05 01:09:26 +01:00
Chicken.html html fixes and section updates 2014-03-15 22:45:43 +00:00
Contents.html Go: Document memory management of C++ classes allocated in Go. Fixes #266. 2014-11-17 08:59:04 -08:00
Contract.html html fixes and section updates 2014-03-15 22:45:43 +00:00
CPlusPlus11.html Document new C++11 strongly typed enumerations support. 2014-12-07 17:10:07 +00:00
CSharp.html C# exception %exception example fix 2014-08-15 19:06:02 +01:00
Customization.html Consistently put whitespace outside of <tt>...</tt> and not inside 2014-11-18 12:44:37 +13:00
D.html html fixes and section updates 2014-03-15 22:45:43 +00:00
Extending.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
fixstyle.py - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Go.html Go: Document memory management of C++ classes allocated in Go. Fixes #266. 2014-11-17 08:59:04 -08:00
Guile.html html fixes and section updates 2014-03-15 22:45:43 +00:00
index.html SWIG 3 doc updates 2014-03-16 21:49:54 +00:00
Introduction.html Fix assorted comment and documentation typos 2014-02-23 17:15:22 +13:00
Java.html Consistently put whitespace outside of <tt>...</tt> and not inside 2014-11-18 12:44:37 +13:00
Javascript.html Remove bogus ; after } in documentation 2014-11-07 15:34:43 +13:00
Library.html html fixes and section updates 2014-03-15 22:45:43 +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 html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Lua.html html fixes 2014-05-09 23:39:02 +01:00
makechap.py SF patch # 3091116 to remove hard coded path to python 2011-01-07 19:57:28 +00:00
Makefile Whitespace cleanup of all Makefiles* 2014-05-02 20:06:11 +02: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 htmldoc patch to htmldoc-1.8.27 2013-05-12 19:14:58 +01:00
Modula3.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Modules.html html fixes and section updates 2014-03-15 22:45:43 +00:00
Mzscheme.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Ocaml.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Octave.html Doc/Manual/Octave.html: update which Octave versions have been tested against 2014-10-22 12:18:16 +02:00
Perl5.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Php.html using an unknown constant emits a notice, not a warning 2014-11-18 12:51:30 +13:00
Pike.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
Preface.html Move installation and install check instructions from README to Preface section in the documentation. 2013-05-03 19:55:42 +01:00
Preprocessor.html Document Javascript related preprocessor macros. 2014-03-31 03:46:51 +02:00
Python.html Consistently put whitespace outside of <tt>...</tt> and not inside 2014-11-18 12:44:37 +13:00
R.html html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html Consistently put whitespace outside of <tt>...</tt> and not inside 2014-11-18 12:44:37 +13:00
Scripting.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13:00
Sections.html Bump version to 3.0.3 2014-06-06 19:56:38 +01:00
style.css Revert css style changes in javascript branch 2014-04-16 07:59:24 +01:00
SWIG.html Consistently put whitespace outside of <tt>...</tt> and not inside 2014-11-18 12:44:37 +13:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Consistently put whitespace outside of <tt>...</tt> and not inside 2014-11-18 12:44:37 +13:00
Tcl.html Consistently put whitespace outside of <tt>...</tt> and not inside 2014-11-18 12:44:37 +13:00
Typemaps.html Add more docs about _global_ prefix in typemap temporary variables 2014-12-06 21:49:42 +00:00
Varargs.html html fixes and section updates 2014-03-15 22:45:43 +00:00
Warnings.html html fixes and section updates 2014-03-15 22:45:43 +00:00
Windows.html Windows examples update for new C# project files. 2014-03-14 23:06:17 +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>