jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Overloaded methods section renamed slightly in docs

Browse source
This commit is contained in:
William S Fulton 2017-09-14 07:58:24 +01:00
commit d5d97a4069
4 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Doc/Manual/Contents.html
View file

@ -236,14 +236,14 @@
<li><a href="SWIGPlus.html#SWIGPlus_nn20">Inheritance</a> <li><a href="SWIGPlus.html#SWIGPlus_nn20">Inheritance</a>
<li><a href="SWIGPlus.html#SWIGPlus_nn21">A brief discussion of multiple inheritance, pointers, and type checking</a> <li><a href="SWIGPlus.html#SWIGPlus_nn21">A brief discussion of multiple inheritance, pointers, and type checking</a>
<li><a href="SWIGPlus.html#SWIGPlus_default_args">Default arguments</a> <li><a href="SWIGPlus.html#SWIGPlus_default_args">Default arguments</a>
<li><a href="SWIGPlus.html#SWIGPlus_overloaded_methods">Wrapping Overloaded Functions and Methods</a> <li><a href="SWIGPlus.html#SWIGPlus_overloaded_methods">Overloaded functions and methods</a>
<ul> <ul>
<li><a href="SWIGPlus.html#SWIGPlus_nn24">Dispatch function generation</a> <li><a href="SWIGPlus.html#SWIGPlus_nn24">Dispatch function generation</a>
<li><a href="SWIGPlus.html#SWIGPlus_nn25">Ambiguity in Overloading</a> <li><a href="SWIGPlus.html#SWIGPlus_nn25">Ambiguity in Overloading</a>
<li><a href="SWIGPlus.html#SWIGPlus_ambiguity_resolution_renaming">Ambiguity resolution and renaming</a> <li><a href="SWIGPlus.html#SWIGPlus_ambiguity_resolution_renaming">Ambiguity resolution and renaming</a>
<li><a href="SWIGPlus.html#SWIGPlus_nn27">Comments on overloading</a> <li><a href="SWIGPlus.html#SWIGPlus_nn27">Comments on overloading</a>
</ul> </ul>
<li><a href="SWIGPlus.html#SWIGPlus_nn28">Wrapping overloaded operators</a> <li><a href="SWIGPlus.html#SWIGPlus_nn28">Overloaded operators</a>
<li><a href="SWIGPlus.html#SWIGPlus_class_extension">Class extension</a> <li><a href="SWIGPlus.html#SWIGPlus_class_extension">Class extension</a>
<li><a href="SWIGPlus.html#SWIGPlus_nn30">Templates</a> <li><a href="SWIGPlus.html#SWIGPlus_nn30">Templates</a>
<ul> <ul>

3
Doc/Manual/Php.html
View file

@ -390,8 +390,7 @@ Although PHP does not support overloading functions natively, swig
will generate dispatch functions which will use <tt>%typecheck</tt> will generate dispatch functions which will use <tt>%typecheck</tt>
typemaps to allow overloading. This dispatch function's operation and typemaps to allow overloading. This dispatch function's operation and
precedence is described in <a precedence is described in <a
href="SWIGPlus.html#SWIGPlus_overloaded_methods">Wrapping href="SWIGPlus.html#SWIGPlus_overloaded_methods">Overloaded functions and methods</a>.
Overloaded Functions and Methods</a>.
</p> </p>
<!-- This isn't correct for 1.3.30 and needs rewriting to reflect reality <!-- This isn't correct for 1.3.30 and needs rewriting to reflect reality

10
Doc/Manual/SWIGPlus.html
View file

@ -39,14 +39,14 @@
<li><a href="#SWIGPlus_nn20">Inheritance</a> <li><a href="#SWIGPlus_nn20">Inheritance</a>
<li><a href="#SWIGPlus_nn21">A brief discussion of multiple inheritance, pointers, and type checking</a> <li><a href="#SWIGPlus_nn21">A brief discussion of multiple inheritance, pointers, and type checking</a>
<li><a href="#SWIGPlus_default_args">Default arguments</a> <li><a href="#SWIGPlus_default_args">Default arguments</a>
<li><a href="#SWIGPlus_overloaded_methods">Wrapping Overloaded Functions and Methods</a> <li><a href="#SWIGPlus_overloaded_methods">Overloaded functions and methods</a>
<ul> <ul>
<li><a href="#SWIGPlus_nn24">Dispatch function generation</a> <li><a href="#SWIGPlus_nn24">Dispatch function generation</a>
<li><a href="#SWIGPlus_nn25">Ambiguity in Overloading</a> <li><a href="#SWIGPlus_nn25">Ambiguity in Overloading</a>
<li><a href="#SWIGPlus_ambiguity_resolution_renaming">Ambiguity resolution and renaming</a> <li><a href="#SWIGPlus_ambiguity_resolution_renaming">Ambiguity resolution and renaming</a>
<li><a href="#SWIGPlus_nn27">Comments on overloading</a> <li><a href="#SWIGPlus_nn27">Comments on overloading</a>
</ul> </ul>
<li><a href="#SWIGPlus_nn28">Wrapping overloaded operators</a> <li><a href="#SWIGPlus_nn28">Overloaded operators</a>
<li><a href="#SWIGPlus_class_extension">Class extension</a> <li><a href="#SWIGPlus_class_extension">Class extension</a>
<li><a href="#SWIGPlus_nn30">Templates</a> <li><a href="#SWIGPlus_nn30">Templates</a>
<ul> <ul>
@ -1772,7 +1772,7 @@ public:
<p> <p>
The wrappers produced are exactly the same as if the above code was instead fed into SWIG. The wrappers produced are exactly the same as if the above code was instead fed into SWIG.
Details of this are covered later in the <a href="#SWIGPlus_overloaded_methods">Wrapping Overloaded Functions and Methods</a> section. Details of this are covered later in the <a href="#SWIGPlus_overloaded_methods">Overloaded functions and methods</a> section.
This approach allows SWIG to wrap all possible default arguments, but can be verbose. This approach allows SWIG to wrap all possible default arguments, but can be verbose.
For example if a method has ten default arguments, then eleven wrapper methods are generated. For example if a method has ten default arguments, then eleven wrapper methods are generated.
</p> </p>
@ -1843,7 +1843,7 @@ Keyword arguments are a language feature of some scripting languages, for exampl
SWIG is unable to support kwargs when wrapping overloaded methods, so the default approach cannot be used. SWIG is unable to support kwargs when wrapping overloaded methods, so the default approach cannot be used.
</p> </p>
<H2><a name="SWIGPlus_overloaded_methods">6.15 Wrapping Overloaded Functions and Methods</a></H2> <H2><a name="SWIGPlus_overloaded_methods">6.15 Overloaded functions and methods</a></H2>
<p> <p>
@ -2616,7 +2616,7 @@ As a general rule, statically typed languages like Java are able to provide more
than dynamically typed languages like Perl, Python, Ruby, and Tcl. than dynamically typed languages like Perl, Python, Ruby, and Tcl.
</p> </p>
<H2><a name="SWIGPlus_nn28">6.16 Wrapping overloaded operators</a></H2> <H2><a name="SWIGPlus_nn28">6.16 Overloaded operators</a></H2>
<p> <p>

2
Doc/Manual/Scilab.html
View file

@ -1133,7 +1133,7 @@ But we can use either use the <tt>get_perimeter()</tt> function of the parent cl
<p> <p>
As explained in <a href="SWIGPlus.html#SWIGPlus_overloaded_methods">6.15</a> SWIG provides support for overloaded functions and constructors. As explained in <a href="SWIGPlus.html#SWIGPlus_overloaded_methods">Overloaded functions and methods</a> SWIG provides support for overloaded functions and constructors.
</p> </p>
<p>As SWIG knows pointer types, the overloading works also with pointer types, here is an example with a function <tt>magnify</tt> overloaded for the previous classes <tt>Shape</tt> and <tt>Circle</tt>: <p>As SWIG knows pointer types, the overloading works also with pointer types, here is an example with a function <tt>magnify</tt> overloaded for the previous classes <tt>Shape</tt> and <tt>Circle</tt>: