[Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.90,1.91

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/api
In directory slayer.i.sourceforge.net:/tmp/cvs-serv2821/Doc/api

Modified Files:
	api.tex 
Log Message:

Added documentation for the new PyModule_*() convenience functions.

This closes SourceForge patch #101233.


Index: api.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/api.tex,v
retrieving revision 1.90
retrieving revision 1.91
diff -C2 -r1.90 -r1.91
*** api.tex	2000/09/22 18:17:49	1.90
--- api.tex	2000/09/23 03:25:42	1.91
***************
*** 3681,3684 ****
--- 3681,3710 ----
  \end{cfuncdesc}
  
+ \begin{cfuncdesc}{int}{PyModule_AddObject}{PyObject *module,
+                                            char *name, PyObject *value}
+ Add an object to \var{module} as \var{name}.  This is a convenience
+ function which can be used from the module's initialization function.
+ This steals a reference to \var{value}.  Returns \code{-1} on error,
+ \code{0} on success.
+ \versionadded{2.0}
+ \end{cfuncdesc}
+ 
+ \begin{cfuncdesc}{int}{PyModule_AddIntConstant}{PyObject *module,
+                                                 char *name, int value}
+ Add an integer constant to \var{module} as \var{name}.  This convenience
+ function can be used from the module's initialization function.
+ Returns \code{-1} on error, \code{0} on success.
+ \versionadded{2.0}
+ \end{cfuncdesc}
+ 
+ \begin{cfuncdesc}{int}{PyModule_AddStringConstant}{PyObject *module,
+                                                    char *name, char *value}
+ Add a string constant to \var{module} as \var{name}.  This convenience
+ function can be used from the module's initialization function.  The
+ string \var{value} must be null-terminated.  Returns \code{-1} on
+ error, \code{0} on success.
+ \versionadded{2.0}
+ \end{cfuncdesc}
+ 
  
  \subsection{CObjects \label{cObjects}}