[Python-checkins] python/dist/src/Include cStringIO.h,2.19,2.20

rhettinger@users.sourceforge.net rhettinger@users.sourceforge.net
Sat, 18 Jan 2003 16:45:04 -0800


Update of /cvsroot/python/python/dist/src/Include
In directory sc8-pr-cvs1:/tmp/cvs-serv16131

Modified Files:
	cStringIO.h 
Log Message:
SF bug #670229: doc improvement for cStringIO.h

Gernot Hillier added more detail to the internal API documentation.


Index: cStringIO.h
===================================================================
RCS file: /cvsroot/python/python/dist/src/Include/cStringIO.h,v
retrieving revision 2.19
retrieving revision 2.20
diff -C2 -d -r2.19 -r2.20
*** cStringIO.h	4 Oct 2002 12:43:02 -0000	2.19
--- cStringIO.h	19 Jan 2003 00:45:01 -0000	2.20
***************
*** 27,40 ****
  static struct PycStringIO_CAPI {
    
!   /* Read a string.  If the last argument is -1, the remainder will be read. */
    int(*cread)(PyObject *, char **, int);
  
!   /* Read a line */
    int(*creadline)(PyObject *, char **);
  
!   /* Write a string */
    int(*cwrite)(PyObject *, char *, int);
  
!   /* Get the cStringIO object as a Python string */
    PyObject *(*cgetvalue)(PyObject *);
  
--- 27,45 ----
  static struct PycStringIO_CAPI {
    
!  /* Read a string from an input object.  If the last argument
!     is -1, the remainder will be read.
!     */
    int(*cread)(PyObject *, char **, int);
  
!  /* Read a line from an input object.  Returns the length of the read
!     line as an int and a pointer inside the object buffer as char** (so
!     the caller doesn't have to provide its own buffer as destination).
!     */
    int(*creadline)(PyObject *, char **);
  
!   /* Write a string to an output object*/
    int(*cwrite)(PyObject *, char *, int);
  
!   /* Get the output object as a Python string (returns new reference). */
    PyObject *(*cgetvalue)(PyObject *);
  
***************
*** 42,46 ****
    PyObject *(*NewOutput)(int);
  
!   /* Create an input object from a Python string */
    PyObject *(*NewInput)(PyObject *);
  
--- 47,53 ----
    PyObject *(*NewOutput)(int);
  
!   /* Create an input object from a Python string
!      (copies the Python string reference).
!      */
    PyObject *(*NewInput)(PyObject *);