diff --git a/Doc/Manual/Android.html b/Doc/Manual/Android.html index 894724188..944a88d65 100644 --- a/Doc/Manual/Android.html +++ b/Doc/Manual/Android.html @@ -48,7 +48,7 @@ This chapter contains a few Android specific notes and examples.

-The examples require the Android SDK and Android NDK which can be installed as per instructions in the links. +The examples require the Android SDK and Android NDK which can be installed as per instructions in the links. The Eclipse version is not required for these examples as just the command line tools are used (shown for Linux as the host, but Windows will be very similar, if not identical in most places). Add the SDK tools and NDK tools to your path and create a directory somewhere for your Android projects (adjust PATH as necessary to where you installed the tools):

@@ -326,7 +326,7 @@ include $(BUILD_SHARED_LIBRARY)

-See the Android NDK documentation for more on the NDK build system and getting started with the NDK. +See the Android NDK documentation for more on the NDK build system and getting started with the NDK. A simple invocation of ndk-build will compile the .c files and generate a shared object/system library. Output will be similar to:

diff --git a/Doc/Manual/CCache.html b/Doc/Manual/CCache.html index 3a7db5c7b..edd435fa1 100644 --- a/Doc/Manual/CCache.html +++ b/Doc/Manual/CCache.html @@ -458,7 +458,7 @@ Thanks to the following people for their contributions to ccache

ccache was written by Andrew Tridgell -http://samba.org/~tridge/. +https://www.samba.org/~tridge/. ccache was adapted to create ccache-swig for use with SWIG by William Fulton.

If you wish to report a problem or make a suggestion then please email diff --git a/Doc/Manual/CSharp.html b/Doc/Manual/CSharp.html index 0526766b5..1fc2d211e 100644 --- a/Doc/Manual/CSharp.html +++ b/Doc/Manual/CSharp.html @@ -64,15 +64,15 @@ The wrapper code implementation uses C# and the Platform Invoke (PInvoke) interf The PInvoke interface has been chosen over Microsoft's Managed C++ interface as it is portable to both Microsoft Windows and non-Microsoft platforms. PInvoke is part of the ECMA/ISO C# specification. It is also better suited for robust production environments due to the Managed C++ flaw called the -Mixed DLL Loading Problem. +Mixed DLL Loading Problem. SWIG C# works equally well on non-Microsoft operating systems such as Linux, Solaris and Apple Mac using -Mono and Portable.NET. +Mono and Portable.NET.

To get the most out of this chapter an understanding of interop is required. -The Microsoft Developer Network (MSDN) has a good reference guide in a section titled "Interop Marshaling". -Monodoc, available from the Mono project, has a very useful section titled Interop with native libraries. +The Microsoft Developer Network (MSDN) has a good reference guide in a section titled "Interop Marshaling". +Monodoc, available from the Mono project, has a very useful section titled Interop with native libraries.

22.1.1 SWIG 2 Compatibility

@@ -763,7 +763,7 @@ another thread may produce enough garbage to trigger garbage collection.

-For more information, see the fixed statement in the C# language reference. +For more information, see the fixed statement in the C# language reference.

diff --git a/Doc/Manual/Doxygen.html b/Doc/Manual/Doxygen.html index b14b05ba3..8a847bb7e 100644 --- a/Doc/Manual/Doxygen.html +++ b/Doc/Manual/Doxygen.html @@ -63,13 +63,13 @@ supported.

The Doxygen Translation module of SWIG adds an extra layer of functionality to SWIG, allowing automated translation of Doxygen formatted comments +"http://www.doxygen.nl/manual/">Doxygen formatted comments from input files into a documentation language more suited for the target language. Currently this module only translates into Javadoc and Pydoc for the SWIG Java and Python modules. Other extensions could be added at a later date. The Doxygen Translation module originally started as -a Google Summer of +a Google Summer of Code proposal from Summer 2008.

@@ -79,14 +79,14 @@ Code proposal from Summer 2008.

To make use of the comment translation system, your documentation comments must be in properly formatted Doxygen. Doxygen comments can be +"http://www.doxygen.nl/manual/">Doxygen. Doxygen comments can be present in your main SWIG interface file or any header file that it imports. You are advised to be validate that your comments compile properly with Doxygen before you try to translate them. Doxygen itself is a more comprehensive tool and can provide you better feedback for correcting any syntax errors that may be present. Please look at Doxygen's Documenting the +"http://www.doxygen.nl/manual/docblocks.html"> Documenting the code for the full comment format specifications. However, SWIG's Doxygen parser will still report many errors and warnings found in comments (like unterminated strings or missing ending tags). @@ -94,7 +94,7 @@ in comments (like unterminated strings or missing ending tags).

Currently, the whole subset of Doxygen comment styles is supported -(See +(See Documenting the code). Here they are:

@@ -293,7 +293,7 @@ make much sense for the other languages without explicit ownership management.

Doxygen syntax is rather rich and, in addition to simple commands such as @transferfull, it is also possible to define commands with arguments. -As explained in Doxygen documentation, +As explained in Doxygen documentation, the arguments can have a range of a single word, everything until the end of line or everything until the end of the next paragraph. Currently, only the "end of line" case is supported using the range="line" argument of the @@ -818,7 +818,7 @@ Here is the list of all Doxygen tags and the description of how they are transla

Doxygen has a wealth of tags such as @latexonly that have no equivalent in Javadoc (all supported tags are listed in -Javadoc documentation). +Javadoc documentation). As a result several tags have no translation or particular use, such as some linking and section tags. These are suppressed with their content just printed out (if the tag has any @@ -1223,9 +1223,9 @@ completely (doxygen:notranslate feature). Then SWIG will just copy the comments to the proxy file and reformat them if needed, but all the comment content will be left as is. As Doxygen doesn't support special commands in Python comments -(see Doxygen +(see Doxygen docs), you may want to use some tool like doxypy -(http://code.foosel.org/doxypy) +(doxypy) to do the work.

diff --git a/Doc/Manual/Go.html b/Doc/Manual/Go.html index 047b46edf..b16c764fb 100644 --- a/Doc/Manual/Go.html +++ b/Doc/Manual/Go.html @@ -1291,7 +1291,7 @@ fraction := modulename.Modf(5.0, ptr)

Since this is ugly, you may want to wrap the swig-generated API with -some additional functions written in go that +some additional functions written in go that hide the ugly details.

There are no char *OUTPUT typemaps. However you can diff --git a/Doc/Manual/Introduction.html b/Doc/Manual/Introduction.html index 1a2e26a6d..149e86877 100644 --- a/Doc/Manual/Introduction.html +++ b/Doc/Manual/Introduction.html @@ -464,7 +464,7 @@ for further information on this and other Autoconf macros.

-There is growing support for SWIG in some build tools, for example CMake +There is growing support for SWIG in some build tools, for example CMake is a cross-platform, open-source build manager with built in support for SWIG. CMake can detect the SWIG executable and many of the target language libraries for linking against. CMake knows how to build shared libraries and loadable modules on many different operating systems. diff --git a/Doc/Manual/Java.html b/Doc/Manual/Java.html index cdefba6b4..e0c6aed03 100644 --- a/Doc/Manual/Java.html +++ b/Doc/Manual/Java.html @@ -1113,11 +1113,10 @@ Typesafe enums have their advantages over using plain integers in that they can However, there are limitations. For example, they cannot be used in switch statements and serialization is an issue. Please look at the following references for further information: -http://java.sun.com/developer/Books/shiftintojava/page1.html#replaceenums Replace Enums with Classes in Effective Java Programming on the Sun website, -Create enumerated constants in Java JavaWorld article, -Java Tip 133: More on typesafe enums and -Java Tip 122: Beware of Java typesafe enumerations JavaWorld tips. +Create enumerated constants in Java JavaWorld article, +Java Tip 133: More on typesafe enums and +Java Tip 122: Beware of Java typesafe enumerations JavaWorld tips.

@@ -2763,7 +2762,7 @@ The finalize() method calls delete() which frees any malloc'd The idea is for delete() to be called when you have finished with the C/C++ object. Ideally you need not call delete(), but rather leave it to the garbage collector to call it from the finalizer. When a program exits, the garbage collector does not guarantee to call all finalizers. -An insight into the reasoning behind this can be obtained from Hans Boehm's Destructors, Finalizers, and Synchronization paper. +An insight into the reasoning behind this can be obtained from Hans Boehm's Destructors, Finalizers, and Synchronization paper. Depending on what the finalizers do and which operating system you use, this may or may not be a problem.

@@ -2787,7 +2786,7 @@ Call the System.runFinalizersOnExit(true) or Runtime.getRuntime().r This method is inherently unsafe. It may result in finalizers being called on live objects while other threads are concurrently manipulating those objects, resulting in erratic behavior or deadlock.

In many cases you will be lucky and find that it works, but it is not to be advocated. -Have a look at Java web site and search for runFinalizersOnExit. +Have a look at Java web site and search for runFinalizersOnExit.

  • @@ -5645,7 +5644,7 @@ This section describes how you can modify SWIG's default wrapping behavior for various C/C++ datatypes using the %typemap directive. You are advised to be familiar with the material in the "Typemaps" chapter. While not absolutely essential knowledge, this section assumes some familiarity with the Java Native Interface (JNI). -JNI documentation can be consulted either online at Sun's Java web site or from a good JNI book. +JNI documentation can be consulted either online at the Java web site or from a good JNI book. The following two books are recommended: