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

Update docs for first 2.0 release

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12067 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
William S Fulton 2010-05-28 23:53:49 +00:00
commit 8e496434d1
4 changed files with 29 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Doc/Manual/Guile.html
View file

@ -767,8 +767,6 @@ guile-modules. For example,</p>
(use-modules ((Test) #:renamer (symbol-prefix-proc 'goops:))) (use-modules ((Test) #:renamer (symbol-prefix-proc 'goops:)))
</pre></div> </pre></div>
<p>TODO: Renaming class name prefixes?</p>
<H3><a name="Guile_nn21"></a>20.10.2 Linking</H3> <H3><a name="Guile_nn21"></a>20.10.2 Linking</H3>

81
Doc/Manual/Preface.html
View file

@ -49,31 +49,19 @@ has since evolved into a general purpose tool that is used in a wide
variety of applications--in fact almost anything where C/C++ programming variety of applications--in fact almost anything where C/C++ programming
is involved. is involved.
<H2><a name="Preface_nn3"></a>1.2 Special Introduction for Version 1.3</H2>
<p>
Since SWIG was released in 1996, its user base and applicability has
continued to grow. Although its rate of development has varied, an
active development effort has continued to make improvements to the
system. Today, nearly a dozen developers are working to create
SWIG-2.0---a system that aims to provide wrapping support for nearly
all of the ANSI C++ standard and approximately ten target languages
including Guile, Java, Mzscheme, Ocaml, Perl, Pike, PHP, Python, Ruby,
and Tcl.
</p>
<H2><a name="Preface_nn4"></a>1.3 SWIG Versions</H2> <H2><a name="Preface_nn4"></a>1.3 SWIG Versions</H2>
<p> <p>
For several years, the most stable version of SWIG has been release In the late 1990's, the most stable version of SWIG was release
1.1p5. Starting with version 1.3, a new version numbering scheme has 1.1p5. Versions 1.3.x were officially development versions and these were released
been adopted. Odd version numbers (1.3, 1.5, etc.) represent over a period of 10 years starting from the year 2000. The final version in the 1.3.x
development versions of SWIG. Even version numbers (1.4, 1.6, etc.) series was 1.3.40, but in truth the 1.3.x series had been stable for many years.
represent stable releases. Currently, developers are working to An official stable version was released along with the decision to make SWIG
create a stable SWIG-2.0 release. Don't let the development status license changes and this gave rise to version 2.0.0 in 2010. The license was clarified
of SWIG-1.3 scare you---it is much more stable (and capable) than SWIG-1.1p5. so that the code that SWIG generated could be distributed
under license terms of the user's choice/requirements and at the same time the SWIG
source was placed under the GNU General Public License version 3.
</p> </p>
<H2><a name="Preface_nn5"></a>1.4 SWIG resources</H2> <H2><a name="Preface_nn5"></a>1.4 SWIG resources</H2>
@ -106,7 +94,7 @@ SWIG along with information about beta releases and future work.
</p> </p>
<p> <p>
SVN access to the latest version of SWIG is also available. More information Subversion access to the latest version of SWIG is also available. More information
about this can be obtained at: about this can be obtained at:
</p> </p>
@ -132,7 +120,7 @@ writing a normal C program.
</p> </p>
<p> <p>
Recent SWIG releases have become significantly more capable in Over time SWIG releases have become significantly more capable in
their C++ handling--especially support for advanced features like their C++ handling--especially support for advanced features like
namespaces, overloaded operators, and templates. Whenever possible, namespaces, overloaded operators, and templates. Whenever possible,
this manual tries to cover the technicalities of this interface. this manual tries to cover the technicalities of this interface.
@ -149,8 +137,7 @@ provide an overview of its capabilities. The remaining chapters are
devoted to specific SWIG language modules and are self devoted to specific SWIG language modules and are self
contained. Thus, if you are using SWIG to build Python interfaces, you contained. Thus, if you are using SWIG to build Python interfaces, you
can probably skip to that chapter and find almost everything you need can probably skip to that chapter and find almost everything you need
to know. Caveat: we are currently working on a documentation rewrite and many to know.
of the older language module chapters are still somewhat out of date.
</p> </p>
<H2><a name="Preface_nn8"></a>1.7 How to avoid reading the manual</H2> <H2><a name="Preface_nn8"></a>1.7 How to avoid reading the manual</H2>
@ -165,24 +152,19 @@ The SWIG distribution also comes with a large directory of
examples that illustrate different topics. examples that illustrate different topics.
</p> </p>
<H2><a name="Preface_nn9"></a>1.8 Backwards Compatibility</H2> <H2><a name="Preface_nn9"></a>1.8 Backwards compatibility</H2>
<p> <p>
If you are a previous user of SWIG, don't expect recent versions of If you are a previous user of SWIG, don't expect
SWIG to provide backwards compatibility. In fact, backwards SWIG to provide complete backwards compatibility.
compatibility issues may arise even between successive 1.3.x releases. Although the developers strive to the utmost to keep backwards compatibility,
Although these incompatibilities are regrettable, SWIG-1.3 is an active this isn't always possible as the
development project. The primary goal of this effort is to make SWIG primary goal over time is to make SWIG
better---a process that would simply be impossible if the developers better---a process that would simply be impossible if the developers
are constantly bogged down with backwards compatibility issues. are constantly bogged down with backwards compatibility issues.
</p> Potential incompatibilities are clearly marked in the detailed release notes
(CHANGES files).
<p>
On a positive note, a few incompatibilities are a small price to pay
for the large number of new features that have been
added---namespaces, templates, smart pointers, overloaded methods,
operators, and more.
</p> </p>
@ -211,26 +193,15 @@ wrapper file. The SWIG preprocessor has defined SWIG_VERSION since SWIG-1.3.11.
<p> <p>
SWIG is an unfunded project that would not be possible without the SWIG is an unfunded project that would not be possible without the
contributions of many people. Most recent SWIG development has been contributions of many people working in their spare time.
supported by Matthias K&ouml;ppe, William Fulton, Lyle Johnson, If you have benefitted from using SWIG, please consider
Richard Palmer, Thien-Thi Nguyen, Jason Stewart, Loic Dachary, Masaki <a href="http://www.swig.org/donate.html">Donating to SWIG</a> to keep development going.
Fukushima, Luigi Ballabio, Sam Liddicott, Art Yerkes, Marcelo Matus, There have been a large varied number of people
Harco de Hilster, John Lenz, and Surendra Singhi. who have made contributions at all levels over time. Contributors
are mentioned either in the COPYRIGHT file or CHANGES files shipped with SWIG or in submitted bugs.
</p> </p>
<p> <p>
Historically, the following people contributed to early versions of SWIG.
Peter Lomdahl, Brad Holian, Shujia Zhou, Niels Jensen, and Tim Germann
at Los Alamos National Laboratory were the first users. Patrick
Tullmann at the University of Utah suggested the idea of automatic
documentation generation. John Schmidt and Kurtis Bleeker at the
University of Utah tested out the early versions. Chris Johnson
supported SWIG's developed at the University of Utah. John Buckman,
Larry Virden, and Tom Schwaller provided valuable input on the first
releases and improving the portability of SWIG. David Fletcher and
Gary Holt have provided a great deal of input on improving SWIG's
Perl5 implementation. Kevin Butler contributed the first Windows NT
port.
<H2><a name="Preface_nn11"></a>1.10 Bug reports</H2> <H2><a name="Preface_nn11"></a>1.10 Bug reports</H2>

21
Doc/Manual/Sections.html
View file

@ -4,20 +4,12 @@
<title>SWIG-1.3 Documentation</title> <title>SWIG-1.3 Documentation</title>
</head> </head>
<body bgcolor="#ffffff"> <body bgcolor="#ffffff">
<H1><a name="Sections"></a>SWIG-1.3 Development Documentation</H1> <H1><a name="Sections"></a>SWIG-2.0 Documentation</H1>
Last update : SWIG-2.0.0 (in progress) Last update : SWIG-2.0.0 (in progress)
<H2>Sections</H2> <H2>Sections</H2>
<p>
The SWIG documentation is being updated to reflect new SWIG
features and enhancements. However, this update process is not quite
finished--there is a lot of old SWIG-1.1 documentation and it is taking
some time to update all of it. Please pardon our dust (or volunteer
to help!).
</p>
<H3>SWIG Core Documentation</H3> <H3>SWIG Core Documentation</H3>
<ul> <ul>
<li><a href="Preface.html#Preface">Preface</a></li> <li><a href="Preface.html#Preface">Preface</a></li>
@ -67,16 +59,5 @@ to help!).
<li><a href="Extending.html#Extending">Extending SWIG</a></li> <li><a href="Extending.html#Extending">Extending SWIG</a></li>
</ul> </ul>
<H3>Documentation that has not yet been updated</H3>
<p>
This documentation has not been completely updated from SWIG-1.1, but most of the topics
still apply to the current release. Make sure you read the
<a href="SWIG.html#SWIG">SWIG Basics</a> chapter before reading
any of these chapters. Also, SWIG-1.3.10 features extensive changes to the
implementation of typemaps. Make sure you read the <a href="Typemaps.html#Typemaps">Typemaps</a>
chapter above if you are using this feature.
</p>
</body> </body>
</html> </html>

4
Doc/Manual/Windows.html
View file

@ -67,7 +67,7 @@ SWIG does not come with the usual Windows type installation program, however it
<p> <p>
The swigwin distribution contains the SWIG Windows executable, swig.exe, which will run on 32 bit versions of Windows, ie Windows 95/98/ME/NT/2000/XP. The swigwin distribution contains the SWIG Windows executable, swig.exe, which will run on 32 bit versions of Windows, ie Windows 95 and later.
If you want to build your own swig.exe have a look at <a href="#Windows_swig_exe">Building swig.exe on Windows</a>. If you want to build your own swig.exe have a look at <a href="#Windows_swig_exe">Building swig.exe on Windows</a>.
</p> </p>
@ -78,7 +78,7 @@ If you want to build your own swig.exe have a look at <a href="#Windows_swig_exe
<p> <p>
Using Microsoft Visual C++ is the most common approach to compiling and linking SWIG's output. Using Microsoft Visual C++ is the most common approach to compiling and linking SWIG's output.
The Examples directory has a few Visual C++ project files (.dsp files). The Examples directory has a few Visual C++ project files (.dsp files).
These were produced by Visual C++ 6, although they should also work in Visual C++ 5. These were produced by Visual C++ 6.
Later versions of Visual Studio should also be able to open and convert these project files. Later versions of Visual Studio should also be able to open and convert these project files.
The C# examples come with .NET 2003 solution (.sln) and project files instead of Visual C++ 6 project files. The C# examples come with .NET 2003 solution (.sln) and project files instead of Visual C++ 6 project files.
The project files have been set up to execute SWIG in a custom build rule for the SWIG interface (.i) file. The project files have been set up to execute SWIG in a custom build rule for the SWIG interface (.i) file.