Support for attaching C# attributes to wrapped methods, variables and enum values. -This is done using the %csattributes feature, see %feature directives. +This is done using the %csattributes feature, see %feature directives. Note that C# attributes are attached to proxy classes and enums using the csattributes typemap. For example, imagine we have a custom attribute class, ThreadSafeAttribute, for labelling thread safety. The following SWIG code shows how to attach this C# attribute to some methods and the class declaration itself: @@ -729,7 +729,7 @@ It is possible to throw a C# Exception from C/C++ code. SWIG already provides the framework for throwing C# exceptions if it is able to detect that a C++ exception could be thrown. Automatically detecting that a C++ exception could be thrown is only possible when a C++ exception specification is used, see Exception specifications. -The Exception handling with %exception section details the %exception feature. +The Exception handling with %exception section details the %exception feature. Customised code for handling exceptions with or without a C++ exception specification is possible and the details follow. However anyone wishing to do this should be familiar with the contents of the sections referred to above.
@@ -1005,7 +1005,7 @@ Actually it will issue this warning for any function beginning with SWIG_CShLet's consider a similar, but more common example that throws a C++ exception from within a wrapped function. -We can use %exception as mentioned in Exception handling with %exception. +We can use %exception as mentioned in Exception handling with %exception.
The SWIG chicken module has support for exceptions thrown from C or C++ code to be caught in scheme. - See Exception handling with %exception + See Exception handling with %exception for more information about declaring exceptions in the interface file.
@@ -519,7 +519,7 @@ all the modules. type. flags is either zero or SWIG_POINTER_DISOWN (see below). -If the owner flag passed to SWIG_NewPointerObj is 1, NewPointerObj will add a
@@ -530,7 +530,7 @@ all the modules.
%newobject directive must be specified for functions whose return values
should be garbage collected. See
- Object ownership and %newobject for more information.
+ Object ownership and %newobject for more information.
In situations where a C or C++ function will assume ownership of a pointer, and thus diff --git a/Doc/Manual/Contents.html b/Doc/Manual/Contents.html index 266d8210c..6ef9acf89 100644 --- a/Doc/Manual/Contents.html +++ b/Doc/Manual/Contents.html @@ -223,7 +223,7 @@
@@ -351,7 +351,7 @@ In this case, the exception handler is only attached to declarations named "allocate". This would include both global and member functions. The names supplied to %exception follow the same rules as for %rename described in the section on -Ambiguity resolution and renaming. +Ambiguity resolution and renaming. For example, if you wanted to define an exception handler for a specific class, you might write this:
@@ -582,7 +582,7 @@ it can be used elsewhere in SWIG. This includes typemaps and helper functions. -@@ -734,7 +734,7 @@ char *strdup(const char *s); The results might not be what you expect.
-@@ -1123,7 +1123,7 @@ specifying or not specifying default arguments in a feature is not applicable as in SWIG-1.3.23 when the approach to wrapping methods with default arguments was changed.
-diff --git a/Doc/Manual/Guile.html b/Doc/Manual/Guile.html index 61b5ba7d6..c39abcb46 100644 --- a/Doc/Manual/Guile.html +++ b/Doc/Manual/Guile.html @@ -409,7 +409,7 @@ See also the "multivalue" example. %feature("constasvar") can be applied to any constant, immutable variable, or enum. Instead of exporting the constant as a function that must be called, the constant will appear as a scheme variable. See -Features and the %feature directive +Features and the %feature directive for info on how to apply the %feature.
@@ -837,7 +837,7 @@ public interface exampleConstants { Note that SWIG has inferred the C type and used an appropriate Java type that will fit the range of all possible values for the C type. By default SWIG generates runtime constants. They are not compiler constants that can, for example, be used in a switch statement. This can be changed by using the %javaconst(flag) directive. It works like all -the other %feature directives. The default is %javaconst(0). +the other %feature directives. The default is %javaconst(0). It is possible to initialize all wrapped constants from pure Java code by placing a %javaconst(1) before SWIG parses the constants. Putting it at the top of your interface file would ensure this. Here is an example: @@ -3751,7 +3751,7 @@ in any way---the extensions only show up in the Java interface. If a C or C++ function throws an error, you may want to convert that error into a Java exception. To do this, you can use the %exception directive. The %exception directive simply lets you rewrite part of the generated wrapper code to include an error check. -It is detailed in full in the Exception handling with %exception section. +It is detailed in full in the Exception handling with %exception section.
diff --git a/Doc/Manual/Library.html b/Doc/Manual/Library.html index 833a38393..c003151ac 100644 --- a/Doc/Manual/Library.html +++ b/Doc/Manual/Library.html @@ -893,7 +893,7 @@ char *foo(); This will release the result if the appropriate target language support is available. SWIG provides the appropriate "newfree" typemap for char * so that the memory is released, however, you may need to provide your own "newfree" typemap for other types. -See Object ownership and %newobject for more details. +See Object ownership and %newobject for more details.
All of this code assumes that your C++ code uses exception specification (which a lot doesn't). If it doesn't consult the "Exception handling with %catches" section -and the "Exception handling with %exception" section, for more details on how to +and the "Exception handling with %exception" section, for more details on how to add exception specification to functions or globally (respectively).
diff --git a/Doc/Manual/Modula3.html b/Doc/Manual/Modula3.html index c4e485202..70d99c305 100644 --- a/Doc/Manual/Modula3.html +++ b/Doc/Manual/Modula3.html @@ -483,7 +483,7 @@ likeAs described in The run-time type checker, diff --git a/Doc/Manual/Perl5.html b/Doc/Manual/Perl5.html index 40500dc5a..777c2f6a2 100644 --- a/Doc/Manual/Perl5.html +++ b/Doc/Manual/Perl5.html @@ -2921,7 +2921,7 @@ not even sure if it really works).
It is possible to override the SWIG generated proxy/shadow methods, using %feature("shadow"). -It works like all the other %feature directives. +It works like all the other %feature directives. Here is a simple example showing how to add some Perl debug code to the constructor:
diff --git a/Doc/Manual/Ruby.html b/Doc/Manual/Ruby.html index 3b1e5c45c..c10702559 100644 --- a/Doc/Manual/Ruby.html +++ b/Doc/Manual/Ruby.html @@ -58,7 +58,7 @@Some containers in the STL allow you to modify their default @@ -6089,7 +6089,7 @@ a function. For example:
- See Object
+ See Object
ownership and %newobject for further details.
In this case, the default SWIG behavior for calling member functions is incorrect. The Ruby object should assume ownership of the returned object. This can be done by using the %newobject directive. -See +See Object ownership and %newobject for more information.
diff --git a/Doc/Manual/SWIG.html b/Doc/Manual/SWIG.html index 02d0ca3a4..0479f30d7 100644 --- a/Doc/Manual/SWIG.html +++ b/Doc/Manual/SWIG.html @@ -1618,7 +1618,7 @@ double y; // Read-writeThe %mutable and %immutable directives are actually -%feature directives defined like this: +%feature directives defined like this:
@@ -1742,7 +1742,7 @@ declarations. If you need to remove a whole section of problematic code, the SWMore powerful variants of %rename and %ignore directives can be used to help wrap C++ overloaded functions and methods or C++ methods which use default arguments. This is described in the -Ambiguity resolution and renaming section in the C++ chapter. +Ambiguity resolution and renaming section in the C++ chapter.
diff --git a/Doc/Manual/SWIGPlus.html b/Doc/Manual/SWIGPlus.html index bcded9166..47ed38186 100644 --- a/Doc/Manual/SWIGPlus.html +++ b/Doc/Manual/SWIGPlus.html @@ -42,7 +42,7 @@
Please see the Features and default arguments section for more information on using %feature with functions with default arguments. -The Ambiguity resolution and renaming section +The Ambiguity resolution and renaming section also deals with using %rename and %ignore on methods with default arguments. If you are writing your own typemaps for types used in methods with default arguments, you may also need to write a typecheck typemap. See the Typemaps and overloading section for details or otherwise @@ -2127,7 +2127,7 @@ it means that the target language module has not yet implemented support for ove functions and methods. The only way to fix the problem is to read the next section.
-@@ -4103,7 +4103,7 @@ more advanced namespace support.
-Some target languages provide support for the nspace feature. +Some target languages provide support for the nspace feature. The feature can be applied to any class, struct, union or enum declared within a named namespace. The feature wraps the type within the target language specific concept of a namespace, for example, a Java package or C# namespace. @@ -4304,7 +4304,7 @@ is outlined in the "throws" typemap s
Since exception specifications are sometimes only used sparingly, this alone may not be enough to properly handle C++ exceptions. To do that, a different set of special SWIG directives are used. -Consult the "Exception handling with %exception" section for details. +Consult the "Exception handling with %exception" section for details. The next section details a way of simulating an exception specification or replacing an existing one.
diff --git a/Doc/Manual/Typemaps.html b/Doc/Manual/Typemaps.html index c815b31d0..dee2bcf7f 100644 --- a/Doc/Manual/Typemaps.html +++ b/Doc/Manual/Typemaps.html @@ -2503,7 +2503,7 @@ string *foo();-See Object ownership and %newobject for further details. +See Object ownership and %newobject for further details.
Note that if your methods do not have an exception specification yet they do throw exceptions, SWIG cannot know how to deal with them. -For a neat way to handle these, see the Exception handling with %exception section. +For a neat way to handle these, see the Exception handling with %exception section.
The "optimal" attribute optimisation is not turned on by default as it has a number of restrictions. Firstly, some code cannot be condensed into a simple call for passing into the copy constructor. -One common occurrence is when %exception is used. +One common occurrence is when %exception is used. Consider adding the following %exception to the example:
@@ -3610,7 +3610,7 @@ structures are chained together in a circularly linked list.This section covers how to use these functions from typemaps. To learn how to call these functions from external files (not the generated _wrap.c file), see -the External access to the run-time system +the External access to the run-time system section.
When pointers are converted in a typemap, the typemap code often looks diff --git a/Doc/Manual/Warnings.html b/Doc/Manual/Warnings.html index 5409248c9..96e35902a 100644 --- a/Doc/Manual/Warnings.html +++ b/Doc/Manual/Warnings.html @@ -102,7 +102,7 @@ int foo(double); // Silently ignored.
The %warnfilter directive has the same semantics as other declaration modifiers like %rename, %ignore and %feature, see the -%feature directive section. For example, if you wanted to +%feature directive section. For example, if you wanted to suppress a warning for a method in a class hierarchy, you could do this: