jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
swig/Doc/Manual
History
Olly Betts de7ed84f77 Recommend compiling with PIC consistently. 
While shared objects with non-PIC code work on some architectures
(notably x86), unless code is always PIC on that arch (not true for x86)
doing so requires runtime relocations, which prevents the object
actually being shared, and means such segments can't be marked as
read-only.
2014-02-21 08:09:58 +13:00
..
Allegrocl.html Fix some typos in directive names 2013-05-12 19:14:59 +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
Android.html More Android docs about the STL and the new extend example 2012-09-13 19:04:29 +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
chapters Rename all C++0x to C++11 and cpp0x to cpp11 2013-10-07 20:37:00 +01:00
Chicken.html New section numbering adding in Android chapter 2011-12-10 16:53:04 +00:00
Contents.html Further Ruby html doc formatting changes 2013-06-08 02:00:47 +01: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
CPlusPlus11.html Add C++11 virtual specifier sequences (final and/or override on methods) 2014-01-03 20:17:48 +00:00
CSharp.html Correct spelling of compatibility. 2013-10-22 14:08:47 -05:00
Customization.html Stop claiming that SWIG_exception() can be used in helper functions 2013-03-21 14:25:14 +13:00
D.html New section numbering adding in Android chapter 2011-12-10 16:53:04 +00:00
Extending.html Errors test-suite overhaul 2014-01-19 00:12:12 +00:00
fixstyle.py - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Go.html fix typo 2014-02-17 19:44:20 +13:00
Guile.html Guile remove references to -gh and -scm from manual 2013-05-13 22:31:29 +02:00
index.html 1.3 => 2.0 for documentation headings 2010-06-02 22:38:41 +00:00
Introduction.html Fix typos 2013-12-12 15:46:33 +13:00
Java.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13:00
Library.html Add std_auto_ptr.i defining typemaps for returning std::auto_ptr<>. 2013-12-03 23:45:20 +01: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 New section numbering adding in Android chapter 2011-12-10 16:53:04 +00:00
Lua.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13: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 htmldoc patch to htmldoc-1.8.27 2013-05-12 19:14:58 +01:00
Modula3.html New section numbering adding in Android chapter 2011-12-10 16:53:04 +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 New section numbering adding in Android chapter 2011-12-10 16:53:04 +00:00
Ocaml.html Fix some minor typos in the doc 2012-08-08 09:30:08 +00:00
Octave.html octave: update support to Octave version 3.8.0 2014-01-13 18:24:17 +13:00
Perl5.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13:00
Php.html PHP: document byref typemap attribute 2014-01-06 14:26:54 +13:00
Pike.html New section numbering adding in Android chapter 2011-12-10 16:53:04 +00: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 HTML doc section update 2012-04-28 15:33:58 +00:00
Python.html Python imports documentation edits 2013-12-24 17:22:42 +00:00
R.html New section numbering adding in Android chapter 2011-12-10 16:53:04 +00:00
README subject/verb agreement 2013-04-30 22:49:12 -03:00
Ruby.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13:00
Scripting.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13:00
Sections.html Bump version to 3.0.0 2013-09-18 00:40:17 +01:00
style.css Remove non-existent html tag 2006-07-08 00:52:51 +00:00
SWIG.html Fix typos 2013-12-12 15:46:33 +13:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13:00
Tcl.html Recommend compiling with PIC consistently. 2014-02-21 08:09:58 +13:00
Typemaps.html Fix a few typos in comments and docs 2013-12-12 11:45:30 +13:00
Varargs.html Fix vararg documentation for Python 3 2013-05-24 23:02:34 +01:00
Warnings.html Deprecation of the 'nestedworkaround' feature 2013-12-13 08:11:17 +00:00
Windows.html Add SWIG_PYTHON_NO_DEBUG macro for building Debug wrappers against the Python Debug dll 2013-06-11 00:22:21 -07: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>