swig/Doc/Manual
Vladimir Kalinin b63c4839fe Nested classes support
Closes #89
Squash merge branch 'master' of https://github.com/wkalinin/swig into wkalinin-nested

By Vladimir Kalinin
* 'master' of https://github.com/wkalinin/swig:
  CPlusPlusOut mode for Octave
  nested class illustration
  fixed "Abstract" flag for nested classes added an example enabled anonymous nested structs runtime test
  porting
  warnings disabled
  porting fixes
  java runtime tests ported
  nested class closing bracket offset fixed
  removed double nested template (not supported by %template parsing)
  template_nested test extended
  parent field made public
  property access fixed
  replaced tabs with spaces
  warning W-reorder
  deprecated warnings removed, derived_nested runtime test added
  optimized string indenting
  Nested classes indenting
  nested classes docs
  fixed the order in which flattened inner classes are added after the outer
  Private nested classes were getting into the type table.
  Java getProxyName() fix for nested classes fixes the case when nested classes is forward declared
  Fix for a case when a nested class inherits from the same base as the outer. (Base class constructor declaration is found first in this case)
  merge fix
  nested C struct first immediate declaration incorrectly renamed sample fixed
  tests updated to reflect nested classes support
  Java nested classes support (1)
  flattening should remove the link to the outer class
  access mode correctly set/restored for nested classes
  nested templates should be skipped while flattening (template nodes themselves, not expanded versions) also non-public nested classes should be ignored
  If nested classes are not supported, default behaviour is flattening, not ignoring flag "nested" is preserved, so, the nested classes can be ignored by user
  nested workaround test updated
  template instantiated within a class is marked as nested for ignoring purposes
  %ignore not applied to the nested classed, because "nested" flag is set too late
  typedef name takes precedence over the real name (reason?)
  unnamed structs should be processed for all the languages
  nested C struct instances are wrapped as "immutable"
  tree building
  typedef declaration for unnamed C structures fixed
  nested classes "flattening"
  fixed %ignoring nested classes
  renamed "nested" attribute to "nested:outer" added "nested" flag, to be used with $ignore (it is not removed while flattening) added nestedClassesSupported() function to the Language interface
  renamed "nested" attribute to "nested:outer" added "nested" flag, to be used with $ignore (it is not removed while flattening) added nestedClassesSupported() function to the Language interface
  tree iteration fix
  dirclassname variable names unified memory issue fixed
  merge error
  ignore unnamed structs for C++
  unnamed nested C structs naming & unnesting
  class added to classes hash under typedef name
  private nested classes skipped
  test updated due to nested templates support
  anonymous structs with inheritance fixed nested_class test to allow anonymous structs w/o declarator
  tests updated: nested workaround removed from namespace_class.i propagated nested template declaration to the C++ file
  injected members scope
  nested tempplates fixes, nested structures in "C" mode parsing added utility function "appendSibling" (like "appendChild")
  nested unnamed structures parsing fixes, access mode restored on nested class end, tdname is properly patched with outer class name prefix
  memory management fixes
  nested templates (1)
  Nested unnamed structs
  Nested class support (1)
  Nested class support (1)
2013-11-29 07:02:34 +00: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 support for C++11 noexcept specification in exception specifications 2013-11-21 20:20:56 +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 Update lingering configure.in references to say configure.ac 2013-03-21 14:41:09 +13:00
fixstyle.py - Updated documentation to use CSS and <div> instead of blockquotes 2005-02-26 02:56:29 +00:00
Go.html Adjust for change in the size of the Go type int. Until some time in 2012-10-05 04:58:00 +00: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 Better linkchecker configuration for checking html links. Fix broken links and update redirected links. 2011-01-08 23:17:23 +00:00
Java.html Documentation edit for the director:except feature and directorthrows typemap 2013-11-07 23:14:21 +00:00
Library.html updated info on lang-specific subdirs in Doc/Manual/Library.html 2013-01-13 23:40:46 +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 Fix some typos in directive names 2013-05-12 19:14:59 +01: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 Update Octave manual to use "swigexample" instead of "example" 2013-05-09 18:34:54 +01:00
Perl5.html Update docs with missing example.c compilation - Bug 3545858 2012-08-05 11:02:49 +00:00
Php.html Director documentation corrections to match reality. 2012-05-30 05:59:46 +00: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 Add %pythonbegin directive. 2013-07-05 06:30:16 +01: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 Further Ruby html doc formatting changes 2013-06-08 02:00:47 +01: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 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 Add support for case conversion characters in regex substitutions. 2013-10-15 07:17:56 +01:00
swig16.png remove svn:executable property where applied incorrectly 2008-11-26 21:54:49 +00:00
SWIGPlus.html Nested classes support 2013-11-29 07:02:34 +00:00
Tcl.html Update docs with missing example.c compilation - Bug 3545858 2012-08-05 11:02:49 +00:00
Typemaps.html Drop guilegh interface 2013-04-28 22:06:24 +02:00
Varargs.html Fix vararg documentation for Python 3 2013-05-24 23:02:34 +01:00
Warnings.html Documentation edit for the director:except feature and directorthrows typemap 2013-11-07 23:14:21 +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

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>