Merge branch 'master' into doxygen
The way Python docstrings are indented has changed on master, so use the standard inspect module in Python autodoc unit test to ignore the differences in their indentation level between -builtin and non-builtin cases to make the test still pass with the branch version, which avoids the use of different (but almost identical) values in the test itself.
This commit is contained in:
Vadim Zeitlin
commit
e668c47b70
1094 changed files with 39390 additions and 11483 deletions
|
|
@ -1,10 +1,12 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>SWIG Users Manual</TITLE>
|
||||
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
||||
</HEAD>
|
||||
<BODY BGCOLOR="#ffffff">
|
||||
|
||||
<H1><a name="Contents"></a>SWIG Users Manual</H1>
|
||||
|
||||
<p>
|
||||
|
|
@ -142,8 +144,8 @@
|
|||
<li><a href="SWIG.html#SWIG_nn10">Basic Type Handling</a>
|
||||
<li><a href="SWIG.html#SWIG_nn11">Global Variables</a>
|
||||
<li><a href="SWIG.html#SWIG_nn12">Constants</a>
|
||||
<li><a href="SWIG.html#SWIG_nn13">A brief word about <tt>const</tt></a>
|
||||
<li><a href="SWIG.html#SWIG_nn14">A cautionary tale of <tt>char *</tt></a>
|
||||
<li><a href="SWIG.html#SWIG_nn13">A brief word about const</a>
|
||||
<li><a href="SWIG.html#SWIG_nn14">A cautionary tale of char *</a>
|
||||
</ul>
|
||||
<li><a href="SWIG.html#SWIG_nn15">Pointers and complex objects</a>
|
||||
<ul>
|
||||
|
|
@ -158,7 +160,7 @@
|
|||
<li><a href="SWIG.html#SWIG_nn22">Passing structures by value</a>
|
||||
<li><a href="SWIG.html#SWIG_nn23">Return by value</a>
|
||||
<li><a href="SWIG.html#SWIG_nn24">Linking to structure variables</a>
|
||||
<li><a href="SWIG.html#SWIG_nn25">Linking to <tt>char *</tt></a>
|
||||
<li><a href="SWIG.html#SWIG_nn25">Linking to char *</a>
|
||||
<li><a href="SWIG.html#SWIG_nn26">Arrays</a>
|
||||
<li><a href="SWIG.html#SWIG_readonly_variables">Creating read-only variables</a>
|
||||
<li><a href="SWIG.html#SWIG_rename_ignore">Renaming and ignoring declarations</a>
|
||||
|
|
@ -285,7 +287,7 @@
|
|||
<li><a href="CPlusPlus11.html#CPlusPlus11_strongly_typed_enumerations">Strongly typed enumerations</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_double_angle_brackets">Double angle brackets</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_explicit_conversion_operators">Explicit conversion operators</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_alias_templates">Alias templates</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_alias_templates">Type alias and alias templates</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_unrestricted_unions">Unrestricted unions</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_variadic_templates">Variadic templates</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_new_string_literals">New string literals</a>
|
||||
|
|
@ -308,7 +310,7 @@
|
|||
<li><a href="CPlusPlus11.html#CPlusPlus11_general_purpose_smart_pointers">General-purpose smart pointers</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_extensible_random_number_facility">Extensible random number facility</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_wrapper_reference">Wrapper reference</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_polymorphous_wrappers_for_function_objects">Polymorphous wrappers for function objects</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_polymorphous_wrappers_for_function_objects">Polymorphic wrappers for function objects</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_type_traits_for_metaprogramming">Type traits for metaprogramming</a>
|
||||
<li><a href="CPlusPlus11.html#CPlusPlus11_uniform_method_for_computing_return_type_of_function_objects">Uniform method for computing return type of function objects</a>
|
||||
</ul>
|
||||
|
|
@ -441,6 +443,8 @@
|
|||
<li><a href="Typemaps.html#Typemaps_special_macro_descriptor">$descriptor(type)</a>
|
||||
<li><a href="Typemaps.html#Typemaps_special_macro_typemap">$typemap(method, typepattern)</a>
|
||||
</ul>
|
||||
<li><a href="Typemaps.html#Typemaps_special_variable_attributes">Special variables and typemap attributes</a>
|
||||
<li><a href="Typemaps.html#Typemaps_special_variables_and_macros">Special variables combined with special variable macros</a>
|
||||
</ul>
|
||||
<li><a href="Typemaps.html#Typemaps_nn25">Common typemap methods</a>
|
||||
<ul>
|
||||
|
|
@ -453,6 +457,7 @@
|
|||
<li><a href="Typemaps.html#Typemaps_nn32">"argout" typemap</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn33">"freearg" typemap</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn34">"newfree" typemap</a>
|
||||
<li><a href="Typemaps.html#Typemaps_ret">"ret" typemap</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn35">"memberin" typemap</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn36">"varin" typemap</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn37">"varout" typemap</a>
|
||||
|
|
@ -478,7 +483,7 @@
|
|||
<li><a href="Typemaps.html#Typemaps_runtime_type_checker_usage">Usage</a>
|
||||
</ul>
|
||||
<li><a href="Typemaps.html#Typemaps_overloading">Typemaps and overloading</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn48">More about <tt>%apply</tt> and <tt>%clear</tt></a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn48">More about %apply and %clear</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn47">Passing data between typemaps</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn52">C++ "this" pointer</a>
|
||||
<li><a href="Typemaps.html#Typemaps_nn51">Where to go for more information?</a>
|
||||
|
|
@ -819,13 +824,13 @@
|
|||
<li><a href="D.html#D_code_injection_typemaps">Code injection typemaps</a>
|
||||
<li><a href="D.html#D_special_variables">Special variable macros</a>
|
||||
</ul>
|
||||
<li><a href="D.html#D_features"><tt>%feature</tt>s</a>
|
||||
<li><a href="D.html#D_features">D and %feature</a>
|
||||
<li><a href="D.html#D_pragmas">Pragmas</a>
|
||||
<li><a href="D.html#D_exceptions">D Exceptions</a>
|
||||
<li><a href="D.html#D_directors">D Directors</a>
|
||||
<li><a href="D.html#D_other_features">Other features</a>
|
||||
<ul>
|
||||
<li><a href="D.html#D_nspace">Extended namespace support (<tt>nspace</tt>)</a>
|
||||
<li><a href="D.html#D_nspace">Extended namespace support (nspace)</a>
|
||||
<li><a href="D.html#D_native_pointer_support">Native pointer support</a>
|
||||
<li><a href="D.html#D_operator_overloading">Operator overloading</a>
|
||||
<li><a href="D.html#D_test_suite">Running the test-suite</a>
|
||||
|
|
@ -845,8 +850,8 @@
|
|||
<li><a href="Go.html#Go_examples">Examples</a>
|
||||
<li><a href="Go.html#Go_running_swig">Running SWIG with Go</a>
|
||||
<ul>
|
||||
<li><a href="Go.html#Go_commandline">Additional Commandline Options</a>
|
||||
<li><a href="Go.html#Go_outputs">Go Output Files</a>
|
||||
<li><a href="Go.html#Go_commandline">Go-specific Commandline Options</a>
|
||||
<li><a href="Go.html#Go_outputs">Generated Wrapper Files</a>
|
||||
</ul>
|
||||
<li><a href="Go.html#Go_basic_tour">A tour of basic C/C++ wrapping</a>
|
||||
<ul>
|
||||
|
|
@ -861,6 +866,16 @@
|
|||
</ul>
|
||||
<li><a href="Go.html#Go_templates">Go Templates</a>
|
||||
<li><a href="Go.html#Go_director_classes">Go Director Classes</a>
|
||||
<ul>
|
||||
<li><a href="Go.html#Go_director_example_cpp_code">Example C++ code</a>
|
||||
<li><a href="Go.html#Go_director_enable">Enable director feature</a>
|
||||
<li><a href="Go.html#Go_director_ctor_dtor">Constructor and destructor</a>
|
||||
<li><a href="Go.html#Go_director_overriding">Override virtual methods</a>
|
||||
<li><a href="Go.html#Go_director_base_methods">Call base methods</a>
|
||||
<li><a href="Go.html#Go_director_subclass">Subclass via embedding</a>
|
||||
<li><a href="Go.html#Go_director_finalizer">Memory management with runtime.SetFinalizer</a>
|
||||
<li><a href="Go.html#Go_director_foobargo_class">Complete FooBarGo example class</a>
|
||||
</ul>
|
||||
<li><a href="Go.html#Go_primitive_type_mappings">Default Go primitive type mappings</a>
|
||||
<li><a href="Go.html#Go_output_arguments">Output arguments</a>
|
||||
<li><a href="Go.html#Go_adding_additional_code">Adding additional go code</a>
|
||||
|
|
@ -953,6 +968,10 @@
|
|||
<li><a href="Java.html#Java_namespaces">C++ namespaces</a>
|
||||
<li><a href="Java.html#Java_templates">C++ templates</a>
|
||||
<li><a href="Java.html#Java_smart_pointers">C++ Smart Pointers</a>
|
||||
<ul>
|
||||
<li><a href="Java.html#Java_smart_pointers_shared_ptr">The shared_ptr Smart Pointer</a>
|
||||
<li><a href="Java.html#Java_smart_pointers_generic">Generic Smart Pointers</a>
|
||||
</ul>
|
||||
</ul>
|
||||
<li><a href="Java.html#Java_further_details">Further details on the generated Java classes</a>
|
||||
<ul>
|
||||
|
|
@ -979,6 +998,7 @@
|
|||
<li><a href="Java.html#Java_proper_enums_classes">Proper Java enum classes</a>
|
||||
<li><a href="Java.html#Java_typeunsafe_enums_classes">Type unsafe enum classes</a>
|
||||
</ul>
|
||||
<li><a href="Java.html#Java_interfaces">Interfaces</a>
|
||||
</ul>
|
||||
<li><a href="Java.html#Java_directors">Cross language polymorphism using directors</a>
|
||||
<ul>
|
||||
|
|
@ -1070,7 +1090,7 @@
|
|||
</ul>
|
||||
<li><a href="Javascript.html#Javascript_embedded_webkit">Embedded Webkit</a>
|
||||
<ul>
|
||||
<li><a href="Javascript.html#Javascript_osx">OSX</a>
|
||||
<li><a href="Javascript.html#Javascript_osx">Mac OS X</a>
|
||||
<li><a href="Javascript.html#Javascript_gtk">GTK</a>
|
||||
</ul>
|
||||
<li><a href="Javascript.html#Javascript_applications_webkit">Creating Applications with node-webkit</a>
|
||||
|
|
@ -1273,10 +1293,10 @@
|
|||
<li><a href="Ocaml.html#Ocaml_nn24">Overriding Methods in Ocaml</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn25">Director Usage Example</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn26">Creating director objects</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn27">Typemaps for directors, <tt>directorin, directorout, directorargout</tt></a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn28"><tt>directorin</tt> typemap</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn29"><tt>directorout</tt> typemap</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn30"><tt>directorargout</tt> typemap</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn27">Typemaps for directors, directorin, directorout, directorargout</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn28">typemap</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn29">directorout typemap</a>
|
||||
<li><a href="Ocaml.html#Ocaml_nn30">directorargout typemap</a>
|
||||
</ul>
|
||||
<li><a href="Ocaml.html#Ocaml_nn31">Exceptions</a>
|
||||
</ul>
|
||||
|
|
@ -1310,6 +1330,10 @@
|
|||
<li><a href="Octave.html#Octave_nn19">Class extension with %extend</a>
|
||||
<li><a href="Octave.html#Octave_nn20">C++ templates</a>
|
||||
<li><a href="Octave.html#Octave_nn21">C++ Smart Pointers</a>
|
||||
<ul>
|
||||
<li><a href="Octave.html#Octave_smart_pointers_shared_ptr">The shared_ptr Smart Pointer</a>
|
||||
<li><a href="Octave.html#Octave_smart_pointers_generic">Generic Smart Pointers</a>
|
||||
</ul>
|
||||
<li><a href="Octave.html#Octave_nn22">Directors (calling Octave from C++ code)</a>
|
||||
<li><a href="Octave.html#Octave_nn23">Threads</a>
|
||||
<li><a href="Octave.html#Octave_nn24">Memory management</a>
|
||||
|
|
@ -1415,7 +1439,7 @@
|
|||
<li><a href="Php.html#Php_nn2_5">Pointers and References</a>
|
||||
<li><a href="Php.html#Php_nn2_6">Structures and C++ classes</a>
|
||||
<ul>
|
||||
<li><a href="Php.html#Php_nn2_6_1">Using <tt>-noproxy</tt></a>
|
||||
<li><a href="Php.html#Php_nn2_6_1">Using -noproxy</a>
|
||||
<li><a href="Php.html#Php_nn2_6_2">Constructors and Destructors</a>
|
||||
<li><a href="Php.html#Php_nn2_6_3">Static Member Variables</a>
|
||||
<li><a href="Php.html#Php_nn2_6_4">Static Member Functions</a>
|
||||
|
|
@ -1494,6 +1518,10 @@
|
|||
<li><a href="Python.html#Python_nn25">C++ namespaces</a>
|
||||
<li><a href="Python.html#Python_nn26">C++ templates</a>
|
||||
<li><a href="Python.html#Python_nn27">C++ Smart Pointers</a>
|
||||
<ul>
|
||||
<li><a href="Python.html#Python_smart_pointers_shared_ptr">The shared_ptr Smart Pointer</a>
|
||||
<li><a href="Python.html#Python_smart_pointers_generic">Generic Smart Pointers</a>
|
||||
</ul>
|
||||
<li><a href="Python.html#Python_nn27a">C++ reference counted objects</a>
|
||||
</ul>
|
||||
<li><a href="Python.html#Python_nn28">Further details on the Python class interface</a>
|
||||
|
|
@ -1502,7 +1530,7 @@
|
|||
<li><a href="Python.html#Python_builtin_types">Built-in Types</a>
|
||||
<ul>
|
||||
<li><a href="Python.html#Python_builtin_limitations">Limitations</a>
|
||||
<li><a href="Python.html#Python_builtin_overloads">Operator overloads -- use them!</a>
|
||||
<li><a href="Python.html#Python_builtin_overloads">Operator overloads and slots -- use them!</a>
|
||||
</ul>
|
||||
<li><a href="Python.html#Python_nn30">Memory management</a>
|
||||
<li><a href="Python.html#Python_nn31">Python 2.2 and classic classes</a>
|
||||
|
|
@ -1567,6 +1595,14 @@
|
|||
<li><a href="Python.html#Python_absrelimports">Absolute and relative imports</a>
|
||||
<li><a href="Python.html#Python_absimport">Enforcing absolute import semantics</a>
|
||||
<li><a href="Python.html#Python_importfrominit">Importing from __init__.py</a>
|
||||
<li><a href="Python.html#Python_implicit_namespace_packages">Implicit Namespace Packages</a>
|
||||
<li><a href="Python.html#Python_package_search">Searching for the wrapper module</a>
|
||||
<ul>
|
||||
<li><a href="Python.html#Python_package_search_both_package_modules">Both modules in the same package</a>
|
||||
<li><a href="Python.html#Python_package_search_wrapper_split">Split modules</a>
|
||||
<li><a href="Python.html#Python_package_search_both_global_modules">Both modules are global</a>
|
||||
<li><a href="Python.html#Python_package_search_static">Statically linked C modules</a>
|
||||
</ul>
|
||||
</ul>
|
||||
<li><a href="Python.html#Python_python3support">Python 3 Support</a>
|
||||
<ul>
|
||||
|
|
@ -1574,6 +1610,7 @@
|
|||
<li><a href="Python.html#Python_nn75">Buffer interface</a>
|
||||
<li><a href="Python.html#Python_nn76">Abstract base classes</a>
|
||||
<li><a href="Python.html#Python_nn77">Byte string output conversion</a>
|
||||
<li><a href="Python.html#Python_2_unicode">Python 2 Unicode</a>
|
||||
</ul>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -1631,6 +1668,10 @@
|
|||
<li><a href="Ruby.html#Ruby_C_STL_Functors">C++ STL Functors</a>
|
||||
<li><a href="Ruby.html#Ruby_C_Iterators">C++ STL Iterators</a>
|
||||
<li><a href="Ruby.html#Ruby_nn24">C++ Smart Pointers</a>
|
||||
<ul>
|
||||
<li><a href="Ruby.html#Ruby_smart_pointers_shared_ptr">The shared_ptr Smart Pointer</a>
|
||||
<li><a href="Ruby.html#Ruby_smart_pointers_generic">Generic Smart Pointers</a>
|
||||
</ul>
|
||||
<li><a href="Ruby.html#Ruby_nn25">Cross-Language Polymorphism</a>
|
||||
<ul>
|
||||
<li><a href="Ruby.html#Ruby_nn26">Exception Unrolling</a>
|
||||
|
|
@ -1761,11 +1802,12 @@
|
|||
<li><a href="Scilab.html#Scilab_wrapping_pointers">Pointers</a>
|
||||
<ul>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_pointers_pointer_adresses">Utility functions</a>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_pointers_null_pointers">Null pointers</a>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_pointers_null_pointers">Null pointers:</a>
|
||||
</ul>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_structs">Structures</a>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_cpp_classes">C++ classes</a>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_cpp_inheritance">C++ inheritance</a>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_cpp_overloading">C++ overloading</a>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_pointers_references_values_arrays">Pointers, references, values, and arrays</a>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_cpp_templates">C++ templates</a>
|
||||
<li><a href="Scilab.html#Scilab_wrapping_cpp_operators">C++ operators</a>
|
||||
|
|
@ -1776,7 +1818,6 @@
|
|||
<li><a href="Scilab.html#Scilab_typemaps">Type mappings and libraries</a>
|
||||
<ul>
|
||||
<li><a href="Scilab.html#Scilab_typemaps_primitive_types">Default primitive type mappings</a>
|
||||
<li><a href="Scilab.html#Scilab_typemaps_non-primitive_types">Default type mappings for non-primitive types</a>
|
||||
<li><a href="Scilab.html#Scilab_typemaps_arrays">Arrays</a>
|
||||
<li><a href="Scilab.html#Scilab_typemaps_pointer-to-pointers">Pointer-to-pointers</a>
|
||||
<li><a href="Scilab.html#Scilab_typemaps_matrices">Matrices</a>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue