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

Update documentation for deprecation and removal of Close()

Browse source
This commit is contained in:
Olly Betts 2014-04-06 06:00:49 +12:00
commit 4959957c18
2 changed files with 4 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/Manual/Extending.html
View file

@ -1500,12 +1500,11 @@ Create a File object wrapper around an existing <tt>FILE *</tt> object.
</div> </div>
<p> <p>
<b><tt>int Close(String_or_FILE *f)</tt></b> There's no explicit function to close a file, just call <tt>Delete(f)</tt> -
this decreases the reference count, and the file will be closed when the
reference count reaches zero.
</p> </p>
<div class="indent">
<p>Closes a file. Has no effect on strings.</p>
<p> <p>
The use of the above I/O functions and strings play a critical role in SWIG. It is The use of the above I/O functions and strings play a critical role in SWIG. It is
common to see small code fragments of code generated using code like this: common to see small code fragments of code generated using code like this:
@ -2832,7 +2831,6 @@ int Python::top(Node *n) {
Delete(f_header); Delete(f_header);
Delete(f_wrappers); Delete(f_wrappers);
Delete(f_init); Delete(f_init);
Close(f_begin);
Delete(f_begin); Delete(f_begin);
return SWIG_OK; return SWIG_OK;

2
Source/DOH/README
View file

@ -65,7 +65,7 @@ Putc(ch,obj) Put a character
Ungetc(ch,obj) Put character back on input stream Ungetc(ch,obj) Put character back on input stream
Seek(obj,offset,whence) Seek Seek(obj,offset,whence) Seek
Tell(obj) Return file pointer Tell(obj) Return file pointer
Close(obj) Close Delete(obj) Decrease the reference count, close file if zero
String Operations String Operations
----------------- -----------------