swig/Doc/Manual
Vadim Zeitlin e30befd138 Correct explanation of how to match on class name in %rename.
Replace incorrect documentation of $parentNode from %rename discussion: it
advised using match$parentNode but this doesn't work because the parent node
is not yet set when %rename is parsed.

Document the "fullname" attribute of %rename which can be used to restrict the
match to the given full name of a declaration only.

git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12291 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2010-11-16 14:08:50 +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 Not all languages were not in alphabetical order 2010-10-04 06:16:21 +00:00
Chicken.html Fix numerous broken links reported by linkchecker 2010-03-06 23:23:43 +00:00
Contents.html Not all languages were not in alphabetical order 2010-10-04 06:16:21 +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 Add C# example showing how to modify the underlying enum type 2010-06-10 06:06:12 +00:00
Customization.html Fix typo. 2010-06-22 11:52:44 +00:00
Extending.html Add missing typemap debug options to docs 2010-09-15 22:26:34 +00:00
fixstyle.py - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Go.html Remove the -rename option in the Go language support. Do a much 2010-06-17 18:59:26 +00:00
Guile.html Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
index.html 1.3 => 2.0 for documentation headings 2010-06-02 22:38:41 +00:00
Introduction.html minor clarification about %{ %} blocks 2010-10-18 18:59:57 +00:00
Java.html remove latin-1 characters 2010-09-28 17:56:48 +00:00
Library.html html fixes and chapter renumbering 2010-06-01 19:19:17 +00:00
Lisp.html Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
Lua.html Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
makechap.py allegrocl: add Doc/Manual/Allegrocl.html, which was missing from last commit. 2005-11-14 18:28:27 +00:00
Makefile dependency fix for the .book files generation 2010-10-04 06:15:53 +00:00
maketoc.py missing DOCTYPE 2004-09-10 22:27:52 +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 Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
Modules.html Fix broken links shown from running 'make linkchecker' 2010-05-29 21:08:42 +00:00
Mzscheme.html Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
Ocaml.html Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
Octave.html Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
Perl5.html Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
Php.html Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
Pike.html Chapter renumbering after Go added 2010-06-10 06:10:55 +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 Chapter renumbering after Go added 2010-06-10 06:10:55 +00:00
R.html Not all languages were not in alphabetical order 2010-10-04 06:16:21 +00:00
README - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Ruby.html Not all languages were not in alphabetical order 2010-10-04 06:16:21 +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.2 and move CHANGES.current to CHANGES 2010-10-05 06:11:50 +00:00
style.css Remove non-existent html tag 2006-07-08 00:52:51 +00:00
SWIG.html Correct explanation of how to match on class name in %rename. 2010-11-16 14:08:50 +00:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Add std_shared_ptr.i and document shared_ptr library 2010-06-01 19:03:55 +00:00
Tcl.html Not all languages were not in alphabetical order 2010-10-04 06:16:21 +00:00
Typemaps.html Add section on Aspect Oriented Programming after discussion on swig-devel 2010-06-08 06:02:56 +00:00
Varargs.html Minor change to previous commit about varargs 2009-11-14 21:54:18 +00:00
Warnings.html Warning section doc update 2010-10-04 05:36:49 +00:00
Windows.html Update docs for first 2.0 release 2010-05-28 23:53:49 +00: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 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>