mirror of https://github.com/swig/swig
fix docs, path provided by Olly
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk/SWIG@9047 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
parent
581c068154
commit
52cfa52b83
|
@ -169,7 +169,7 @@ a <tt>Derived</tt> instance and call the wrapper for <tt>Base::method</tt>.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<b>%feature("compactdefaultargs")</b><br>
|
<b>%feature("compactdefaultargs")</b><br>
|
||||||
This feature can reduce the number of wrapper methods when wrapping methods with default arguments. The section on <a href="SWIGPlus.html#SWIGPlus_default_args">default arguments</a> discusses the feature and it's limitations.
|
This feature can reduce the number of wrapper methods when wrapping methods with default arguments. The section on <a href="SWIGPlus.html#SWIGPlus_default_args">default arguments</a> discusses the feature and its limitations.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
|
|
|
@ -1021,7 +1021,7 @@ dereference the pointer from Python. Of course, that isn't much of a concern in
|
||||||
In older versions of Swig (1.3.22 or older), pointers were represented
|
In older versions of Swig (1.3.22 or older), pointers were represented
|
||||||
using a plain string object. If you have an old package that still
|
using a plain string object. If you have an old package that still
|
||||||
requires that representation, or you just feel nostalgic, you can
|
requires that representation, or you just feel nostalgic, you can
|
||||||
always retreive it by casting the pointer object to a string:
|
always retrieve it by casting the pointer object to a string:
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div class="targetlang"><pre>
|
<div class="targetlang"><pre>
|
||||||
|
@ -4583,7 +4583,7 @@ class object (if applicable).
|
||||||
<p>
|
<p>
|
||||||
Using docstrings in Python code is becoming more and more important
|
Using docstrings in Python code is becoming more and more important
|
||||||
and more tools are coming on the scene that take advantage of them,
|
and more tools are coming on the scene that take advantage of them,
|
||||||
everything from full-blown documentaiton generators to class browsers
|
everything from full-blown documentation generators to class browsers
|
||||||
and popup call-tips in Python-aware IDEs. Given the way that SWIG
|
and popup call-tips in Python-aware IDEs. Given the way that SWIG
|
||||||
generates the proxy code by default, your users will normally get
|
generates the proxy code by default, your users will normally get
|
||||||
something like <tt>"function_name(*args)"</tt> in the popup calltip of
|
something like <tt>"function_name(*args)"</tt> in the popup calltip of
|
||||||
|
|
|
@ -822,7 +822,7 @@ public:
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
SWIG handles default arguments by generating an extra overloaded method for each defaulted argument.
|
SWIG handles default arguments by generating an extra overloaded method for each defaulted argument.
|
||||||
SWIG is effectively handling methods with default arguments as if it had wrapped the equivalent overloaded methods.
|
SWIG is effectively handling methods with default arguments as if it was wrapping the equivalent overloaded methods.
|
||||||
Thus for the example above, it is as if we had instead given the following to SWIG:
|
Thus for the example above, it is as if we had instead given the following to SWIG:
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
@ -839,7 +839,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 is 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">Wrapping 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>
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
/* This interface file checks how well SWIG handles passing data back
|
/* This interface file checks how well SWIG handles passing data back
|
||||||
through arguments WITHOUT returning it seperatly; for the cases where
|
through arguments WITHOUT returning it separately; for the cases where
|
||||||
maybe multiple values are passed by refernce and all want changing */
|
maybe multiple values are passed by reference and all want changing */
|
||||||
|
|
||||||
%module argout
|
%module argout
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
this will replace the code used to retreive an integer value for all
|
this will replace the code used to retrieve an integer value for all
|
||||||
the typemaps that need it, including:
|
the typemaps that need it, including:
|
||||||
|
|
||||||
int, std::vector<int>, std::list<std::pair<int,int> >, etc.
|
int, std::vector<int>, std::list<std::pair<int,int> >, etc.
|
||||||
|
|
|
@ -93,7 +93,7 @@ SWIG_ZTS_SetPointerZval(zval *z, void *ptr, swig_type_info *type, int newobject,
|
||||||
|
|
||||||
/* This is a new pointer conversion routine
|
/* This is a new pointer conversion routine
|
||||||
Taking the native pointer p (which would have been converted from the old
|
Taking the native pointer p (which would have been converted from the old
|
||||||
string pointer) and it's php type id, and it's type name (which also would
|
string pointer) and its php type id, and its type name (which also would
|
||||||
have come from the old string pointer) it converts it to ptr calling
|
have come from the old string pointer) it converts it to ptr calling
|
||||||
appropriate casting functions according to ty
|
appropriate casting functions according to ty
|
||||||
Sadly PHP has no API to find a type name from a type id, only from an instance
|
Sadly PHP has no API to find a type name from a type id, only from an instance
|
||||||
|
|
|
@ -22,7 +22,7 @@
|
||||||
|
|
||||||
/*
|
/*
|
||||||
Use -DSWIG_PYTHON_DIRECTOR_NO_VTABLE if you don't want to generate a 'virtual
|
Use -DSWIG_PYTHON_DIRECTOR_NO_VTABLE if you don't want to generate a 'virtual
|
||||||
table', and avoid multiple GetAttr calls to retreive the python
|
table', and avoid multiple GetAttr calls to retrieve the python
|
||||||
methods.
|
methods.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
this will replace the code used to retreive an integer value for all
|
this will replace the code used to retrieve an integer value for all
|
||||||
the typemaps that need it, including:
|
the typemaps that need it, including:
|
||||||
|
|
||||||
int, std::vector<int>, std::list<std::pair<int,int> >, etc.
|
int, std::vector<int>, std::list<std::pair<int,int> >, etc.
|
||||||
|
|
|
@ -14,7 +14,7 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
this will replace the code used to retreive an integer value for all
|
this will replace the code used to retrieve an integer value for all
|
||||||
the typemaps that need it, including:
|
the typemaps that need it, including:
|
||||||
|
|
||||||
int, std::vector<int>, std::list<std::pair<int,int> >, etc.
|
int, std::vector<int>, std::list<std::pair<int,int> >, etc.
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
this will replace the code used to retreive an integer value for all
|
this will replace the code used to retrieve an integer value for all
|
||||||
the typemaps that need it, including:
|
the typemaps that need it, including:
|
||||||
|
|
||||||
int, std::vector<int>, std::list<std::pair<int,int> >, etc.
|
int, std::vector<int>, std::list<std::pair<int,int> >, etc.
|
||||||
|
|
|
@ -49,8 +49,8 @@
|
||||||
%delete_array(cptr) Delete an array
|
%delete_array(cptr) Delete an array
|
||||||
|
|
||||||
|
|
||||||
Auxiliar loop macros:
|
Auxiliary loop macros:
|
||||||
---------------------
|
----------------------
|
||||||
|
|
||||||
%formacro(Macro, Args...) or %formacro_1(Macro, Args...)
|
%formacro(Macro, Args...) or %formacro_1(Macro, Args...)
|
||||||
for i in Args
|
for i in Args
|
||||||
|
|
|
@ -1048,13 +1048,13 @@ public:
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Now convert from php to C variables */
|
/* Now convert from php to C variables */
|
||||||
// At this point, argcount if used is the number of deliberatly passed args
|
// At this point, argcount if used is the number of deliberately passed args
|
||||||
// not including this_ptr even if it is used.
|
// not including this_ptr even if it is used.
|
||||||
// It means error messages may be out by argbase with error
|
// It means error messages may be out by argbase with error
|
||||||
// reports. We can either take argbase into account when raising
|
// reports. We can either take argbase into account when raising
|
||||||
// errors, or find a better way of dealing with _thisptr
|
// errors, or find a better way of dealing with _thisptr
|
||||||
// I would like, if objects are wrapped, to assume _thisptr is always
|
// I would like, if objects are wrapped, to assume _thisptr is always
|
||||||
// _this and the and not the first argument
|
// _this and not the first argument
|
||||||
// This may mean looking at Lang::memberfunctionhandler
|
// This may mean looking at Lang::memberfunctionhandler
|
||||||
|
|
||||||
for (i = 0, p = l; i < num_arguments; i++) {
|
for (i = 0, p = l; i < num_arguments; i++) {
|
||||||
|
|
Loading…
Reference in New Issue