mirror of
https://github.com/python/cpython.git
synced 2025-11-01 02:38:53 +00:00
Patch #568124: Add doc string macros.
This commit is contained in:
Martin v. Löwis
parent
654c11ee3a
commit
14f8b4cfcb
63 changed files with 1509 additions and 1625 deletions
|
|
@ -272,9 +272,8 @@ GetConfig(alcobject *self, PyObject *args, int (*func)(ALconfig))
|
|||
return PyInt_FromLong((long) par);
|
||||
}
|
||||
|
||||
static char alc_SetWidth__doc__[] =
|
||||
"alSetWidth: set the wordsize for integer audio data."
|
||||
;
|
||||
PyDoc_STRVAR(alc_SetWidth__doc__,
|
||||
"alSetWidth: set the wordsize for integer audio data.");
|
||||
|
||||
static PyObject *
|
||||
alc_SetWidth(alcobject *self, PyObject *args)
|
||||
|
|
@ -283,9 +282,8 @@ alc_SetWidth(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_GetWidth__doc__[] =
|
||||
"alGetWidth: get the wordsize for integer audio data."
|
||||
;
|
||||
PyDoc_STRVAR(alc_GetWidth__doc__,
|
||||
"alGetWidth: get the wordsize for integer audio data.");
|
||||
|
||||
static PyObject *
|
||||
alc_GetWidth(alcobject *self, PyObject *args)
|
||||
|
|
@ -294,9 +292,9 @@ alc_GetWidth(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_SetSampFmt__doc__[] =
|
||||
"alSetSampFmt: set the sample format setting in an audio ALconfig structure."
|
||||
;
|
||||
PyDoc_STRVAR(alc_SetSampFmt__doc__,
|
||||
"alSetSampFmt: set the sample format setting in an audio ALconfig "
|
||||
"structure.");
|
||||
|
||||
static PyObject *
|
||||
alc_SetSampFmt(alcobject *self, PyObject *args)
|
||||
|
|
@ -305,9 +303,9 @@ alc_SetSampFmt(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_GetSampFmt__doc__[] =
|
||||
"alGetSampFmt: get the sample format setting in an audio ALconfig structure."
|
||||
;
|
||||
PyDoc_STRVAR(alc_GetSampFmt__doc__,
|
||||
"alGetSampFmt: get the sample format setting in an audio ALconfig "
|
||||
"structure.");
|
||||
|
||||
static PyObject *
|
||||
alc_GetSampFmt(alcobject *self, PyObject *args)
|
||||
|
|
@ -316,9 +314,8 @@ alc_GetSampFmt(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_SetChannels__doc__[] =
|
||||
"alSetChannels: set the channel settings in an audio ALconfig."
|
||||
;
|
||||
PyDoc_STRVAR(alc_SetChannels__doc__,
|
||||
"alSetChannels: set the channel settings in an audio ALconfig.");
|
||||
|
||||
static PyObject *
|
||||
alc_SetChannels(alcobject *self, PyObject *args)
|
||||
|
|
@ -327,9 +324,8 @@ alc_SetChannels(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_GetChannels__doc__[] =
|
||||
"alGetChannels: get the channel settings in an audio ALconfig."
|
||||
;
|
||||
PyDoc_STRVAR(alc_GetChannels__doc__,
|
||||
"alGetChannels: get the channel settings in an audio ALconfig.");
|
||||
|
||||
static PyObject *
|
||||
alc_GetChannels(alcobject *self, PyObject *args)
|
||||
|
|
@ -338,9 +334,8 @@ alc_GetChannels(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_SetFloatMax__doc__[] =
|
||||
"alSetFloatMax: set the maximum value of floating point sample data."
|
||||
;
|
||||
PyDoc_STRVAR(alc_SetFloatMax__doc__,
|
||||
"alSetFloatMax: set the maximum value of floating point sample data.");
|
||||
|
||||
static PyObject *
|
||||
alc_SetFloatMax(alcobject *self, PyObject *args)
|
||||
|
|
@ -356,9 +351,8 @@ alc_SetFloatMax(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_GetFloatMax__doc__[] =
|
||||
"alGetFloatMax: get the maximum value of floating point sample data."
|
||||
;
|
||||
PyDoc_STRVAR(alc_GetFloatMax__doc__,
|
||||
"alGetFloatMax: get the maximum value of floating point sample data.");
|
||||
|
||||
static PyObject *
|
||||
alc_GetFloatMax(alcobject *self, PyObject *args)
|
||||
|
|
@ -373,9 +367,8 @@ alc_GetFloatMax(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_SetDevice__doc__[] =
|
||||
"alSetDevice: set the device setting in an audio ALconfig structure."
|
||||
;
|
||||
PyDoc_STRVAR(alc_SetDevice__doc__,
|
||||
"alSetDevice: set the device setting in an audio ALconfig structure.");
|
||||
|
||||
static PyObject *
|
||||
alc_SetDevice(alcobject *self, PyObject *args)
|
||||
|
|
@ -384,9 +377,8 @@ alc_SetDevice(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_GetDevice__doc__[] =
|
||||
"alGetDevice: get the device setting in an audio ALconfig structure."
|
||||
;
|
||||
PyDoc_STRVAR(alc_GetDevice__doc__,
|
||||
"alGetDevice: get the device setting in an audio ALconfig structure.");
|
||||
|
||||
static PyObject *
|
||||
alc_GetDevice(alcobject *self, PyObject *args)
|
||||
|
|
@ -395,9 +387,8 @@ alc_GetDevice(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_SetQueueSize__doc__[] =
|
||||
"alSetQueueSize: set audio port buffer size."
|
||||
;
|
||||
PyDoc_STRVAR(alc_SetQueueSize__doc__,
|
||||
"alSetQueueSize: set audio port buffer size.");
|
||||
|
||||
static PyObject *
|
||||
alc_SetQueueSize(alcobject *self, PyObject *args)
|
||||
|
|
@ -406,9 +397,8 @@ alc_SetQueueSize(alcobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alc_GetQueueSize__doc__[] =
|
||||
"alGetQueueSize: get audio port buffer size."
|
||||
;
|
||||
PyDoc_STRVAR(alc_GetQueueSize__doc__,
|
||||
"alGetQueueSize: get audio port buffer size.");
|
||||
|
||||
static PyObject *
|
||||
alc_GetQueueSize(alcobject *self, PyObject *args)
|
||||
|
|
@ -590,9 +580,7 @@ alc_getattr(alcobject *self, char *name)
|
|||
return Py_FindMethod(alc_methods, (PyObject *)self, name);
|
||||
}
|
||||
|
||||
static char Alctype__doc__[] =
|
||||
""
|
||||
;
|
||||
PyDoc_STRVAR(Alctype__doc__, "");
|
||||
|
||||
static PyTypeObject Alctype = {
|
||||
PyObject_HEAD_INIT(&PyType_Type)
|
||||
|
|
@ -624,9 +612,8 @@ static PyTypeObject Alctype = {
|
|||
|
||||
#ifdef AL_NO_ELEM /* IRIX 6 */
|
||||
|
||||
static char alp_SetConfig__doc__[] =
|
||||
"alSetConfig: set the ALconfig of an audio ALport."
|
||||
;
|
||||
PyDoc_STRVAR(alp_SetConfig__doc__,
|
||||
"alSetConfig: set the ALconfig of an audio ALport.");
|
||||
|
||||
static PyObject *
|
||||
alp_SetConfig(alpobject *self, PyObject *args)
|
||||
|
|
@ -641,9 +628,8 @@ alp_SetConfig(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_GetConfig__doc__[] =
|
||||
"alGetConfig: get the ALconfig of an audio ALport."
|
||||
;
|
||||
PyDoc_STRVAR(alp_GetConfig__doc__,
|
||||
"alGetConfig: get the ALconfig of an audio ALport.");
|
||||
|
||||
static PyObject *
|
||||
alp_GetConfig(alpobject *self, PyObject *args)
|
||||
|
|
@ -657,9 +643,8 @@ alp_GetConfig(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_GetResource__doc__[] =
|
||||
"alGetResource: get the resource associated with an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_GetResource__doc__,
|
||||
"alGetResource: get the resource associated with an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_GetResource(alpobject *self, PyObject *args)
|
||||
|
|
@ -674,9 +659,8 @@ alp_GetResource(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_GetFD__doc__[] =
|
||||
"alGetFD: get the file descriptor for an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_GetFD__doc__,
|
||||
"alGetFD: get the file descriptor for an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_GetFD(alpobject *self, PyObject *args)
|
||||
|
|
@ -693,9 +677,9 @@ alp_GetFD(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_GetFilled__doc__[] =
|
||||
"alGetFilled: return the number of filled sample frames in an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_GetFilled__doc__,
|
||||
"alGetFilled: return the number of filled sample frames in "
|
||||
"an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_GetFilled(alpobject *self, PyObject *args)
|
||||
|
|
@ -710,9 +694,9 @@ alp_GetFilled(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_GetFillable__doc__[] =
|
||||
"alGetFillable: report the number of unfilled sample frames in an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_GetFillable__doc__,
|
||||
"alGetFillable: report the number of unfilled sample frames "
|
||||
"in an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_GetFillable(alpobject *self, PyObject *args)
|
||||
|
|
@ -727,9 +711,8 @@ alp_GetFillable(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_ReadFrames__doc__[] =
|
||||
"alReadFrames: read sample frames from an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_ReadFrames__doc__,
|
||||
"alReadFrames: read sample frames from an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_ReadFrames(alpobject *self, PyObject *args)
|
||||
|
|
@ -796,9 +779,8 @@ alp_ReadFrames(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_DiscardFrames__doc__[] =
|
||||
"alDiscardFrames: discard audio from an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_DiscardFrames__doc__,
|
||||
"alDiscardFrames: discard audio from an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_DiscardFrames(alpobject *self, PyObject *args)
|
||||
|
|
@ -819,9 +801,8 @@ alp_DiscardFrames(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_ZeroFrames__doc__[] =
|
||||
"alZeroFrames: write zero-valued sample frames to an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_ZeroFrames__doc__,
|
||||
"alZeroFrames: write zero-valued sample frames to an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_ZeroFrames(alpobject *self, PyObject *args)
|
||||
|
|
@ -845,9 +826,8 @@ alp_ZeroFrames(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_SetFillPoint__doc__[] =
|
||||
"alSetFillPoint: set low- or high-water mark for an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_SetFillPoint__doc__,
|
||||
"alSetFillPoint: set low- or high-water mark for an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_SetFillPoint(alpobject *self, PyObject *args)
|
||||
|
|
@ -865,9 +845,8 @@ alp_SetFillPoint(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_GetFillPoint__doc__[] =
|
||||
"alGetFillPoint: get low- or high-water mark for an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_GetFillPoint__doc__,
|
||||
"alGetFillPoint: get low- or high-water mark for an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_GetFillPoint(alpobject *self, PyObject *args)
|
||||
|
|
@ -884,9 +863,9 @@ alp_GetFillPoint(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_GetFrameNumber__doc__[] =
|
||||
"alGetFrameNumber: get the absolute sample frame number associated with a port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_GetFrameNumber__doc__,
|
||||
"alGetFrameNumber: get the absolute sample frame number "
|
||||
"associated with a port.");
|
||||
|
||||
static PyObject *
|
||||
alp_GetFrameNumber(alpobject *self, PyObject *args)
|
||||
|
|
@ -903,9 +882,9 @@ alp_GetFrameNumber(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_GetFrameTime__doc__[] =
|
||||
"alGetFrameTime: get the time at which a sample frame came in or will go out."
|
||||
;
|
||||
PyDoc_STRVAR(alp_GetFrameTime__doc__,
|
||||
"alGetFrameTime: get the time at which a sample frame came "
|
||||
"in or will go out.");
|
||||
|
||||
static PyObject *
|
||||
alp_GetFrameTime(alpobject *self, PyObject *args)
|
||||
|
|
@ -931,9 +910,8 @@ alp_GetFrameTime(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_WriteFrames__doc__[] =
|
||||
"alWriteFrames: write sample frames to an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_WriteFrames__doc__,
|
||||
"alWriteFrames: write sample frames to an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_WriteFrames(alpobject *self, PyObject *args)
|
||||
|
|
@ -997,9 +975,7 @@ alp_WriteFrames(alpobject *self, PyObject *args)
|
|||
}
|
||||
|
||||
|
||||
static char alp_ClosePort__doc__[] =
|
||||
"alClosePort: close an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(alp_ClosePort__doc__, "alClosePort: close an audio port.");
|
||||
|
||||
static PyObject *
|
||||
alp_ClosePort(alpobject *self, PyObject *args)
|
||||
|
|
@ -1314,9 +1290,7 @@ alp_getattr(alpobject *self, char *name)
|
|||
return Py_FindMethod(alp_methods, (PyObject *)self, name);
|
||||
}
|
||||
|
||||
static char Alptype__doc__[] =
|
||||
""
|
||||
;
|
||||
PyDoc_STRVAR(Alptype__doc__, "");
|
||||
|
||||
static PyTypeObject Alptype = {
|
||||
PyObject_HEAD_INIT(&PyType_Type)
|
||||
|
|
@ -1349,9 +1323,8 @@ static PyTypeObject Alptype = {
|
|||
|
||||
#ifdef AL_NO_ELEM /* IRIX 6 */
|
||||
|
||||
static char al_NewConfig__doc__[] =
|
||||
"alNewConfig: create and initialize an audio ALconfig structure."
|
||||
;
|
||||
PyDoc_STRVAR(al_NewConfig__doc__,
|
||||
"alNewConfig: create and initialize an audio ALconfig structure.");
|
||||
|
||||
static PyObject *
|
||||
al_NewConfig(PyObject *self, PyObject *args)
|
||||
|
|
@ -1365,9 +1338,8 @@ al_NewConfig(PyObject *self, PyObject *args)
|
|||
return newalcobject(config);
|
||||
}
|
||||
|
||||
static char al_OpenPort__doc__[] =
|
||||
"alOpenPort: open an audio port."
|
||||
;
|
||||
PyDoc_STRVAR(al_OpenPort__doc__,
|
||||
"alOpenPort: open an audio port.");
|
||||
|
||||
static PyObject *
|
||||
al_OpenPort(PyObject *self, PyObject *args)
|
||||
|
|
@ -1383,9 +1355,8 @@ al_OpenPort(PyObject *self, PyObject *args)
|
|||
return newalpobject(port);
|
||||
}
|
||||
|
||||
static char al_Connect__doc__[] =
|
||||
"alConnect: connect two audio I/O resources."
|
||||
;
|
||||
PyDoc_STRVAR(al_Connect__doc__,
|
||||
"alConnect: connect two audio I/O resources.");
|
||||
|
||||
static PyObject *
|
||||
al_Connect(PyObject *self, PyObject *args)
|
||||
|
|
@ -1423,9 +1394,8 @@ al_Connect(PyObject *self, PyObject *args)
|
|||
return PyInt_FromLong((long) id);
|
||||
}
|
||||
|
||||
static char al_Disconnect__doc__[] =
|
||||
"alDisconnect: delete a connection between two audio I/O resources."
|
||||
;
|
||||
PyDoc_STRVAR(al_Disconnect__doc__,
|
||||
"alDisconnect: delete a connection between two audio I/O resources.");
|
||||
|
||||
static PyObject *
|
||||
al_Disconnect(PyObject *self, PyObject *args)
|
||||
|
|
@ -1440,9 +1410,8 @@ al_Disconnect(PyObject *self, PyObject *args)
|
|||
return Py_None;
|
||||
}
|
||||
|
||||
static char al_GetParams__doc__[] =
|
||||
"alGetParams: get the values of audio resource parameters."
|
||||
;
|
||||
PyDoc_STRVAR(al_GetParams__doc__,
|
||||
"alGetParams: get the values of audio resource parameters.");
|
||||
|
||||
static PyObject *
|
||||
al_GetParams(PyObject *self, PyObject *args)
|
||||
|
|
@ -1585,9 +1554,8 @@ al_GetParams(PyObject *self, PyObject *args)
|
|||
return NULL;
|
||||
}
|
||||
|
||||
static char al_SetParams__doc__[] =
|
||||
"alSetParams: set the values of audio resource parameters."
|
||||
;
|
||||
PyDoc_STRVAR(al_SetParams__doc__,
|
||||
"alSetParams: set the values of audio resource parameters.");
|
||||
|
||||
static PyObject *
|
||||
al_SetParams(PyObject *self, PyObject *args)
|
||||
|
|
@ -1631,9 +1599,8 @@ al_SetParams(PyObject *self, PyObject *args)
|
|||
return NULL;
|
||||
}
|
||||
|
||||
static char al_QueryValues__doc__[] =
|
||||
"alQueryValues: get the set of possible values for a parameter."
|
||||
;
|
||||
PyDoc_STRVAR(al_QueryValues__doc__,
|
||||
"alQueryValues: get the set of possible values for a parameter.");
|
||||
|
||||
static PyObject *
|
||||
al_QueryValues(PyObject *self, PyObject *args)
|
||||
|
|
@ -1711,9 +1678,9 @@ al_QueryValues(PyObject *self, PyObject *args)
|
|||
return res;
|
||||
}
|
||||
|
||||
static char al_GetParamInfo__doc__[] =
|
||||
"alGetParamInfo: get information about a parameter on a particular audio resource."
|
||||
;
|
||||
PyDoc_STRVAR(al_GetParamInfo__doc__,
|
||||
"alGetParamInfo: get information about a parameter on "
|
||||
"a particular audio resource.");
|
||||
|
||||
static PyObject *
|
||||
al_GetParamInfo(PyObject *self, PyObject *args)
|
||||
|
|
@ -1794,9 +1761,8 @@ al_GetParamInfo(PyObject *self, PyObject *args)
|
|||
return v;
|
||||
}
|
||||
|
||||
static char al_GetResourceByName__doc__[] =
|
||||
"alGetResourceByName: find an audio resource by name."
|
||||
;
|
||||
PyDoc_STRVAR(al_GetResourceByName__doc__,
|
||||
"alGetResourceByName: find an audio resource by name.");
|
||||
|
||||
static PyObject *
|
||||
al_GetResourceByName(PyObject *self, PyObject *args)
|
||||
|
|
@ -1811,9 +1777,8 @@ al_GetResourceByName(PyObject *self, PyObject *args)
|
|||
return PyInt_FromLong((long) res);
|
||||
}
|
||||
|
||||
static char al_IsSubtype__doc__[] =
|
||||
"alIsSubtype: indicate if one resource type is a subtype of another."
|
||||
;
|
||||
PyDoc_STRVAR(al_IsSubtype__doc__,
|
||||
"alIsSubtype: indicate if one resource type is a subtype of another.");
|
||||
|
||||
static PyObject *
|
||||
al_IsSubtype(PyObject *self, PyObject *args)
|
||||
|
|
@ -1825,9 +1790,7 @@ al_IsSubtype(PyObject *self, PyObject *args)
|
|||
return PyInt_FromLong((long) alIsSubtype(type, subtype));
|
||||
}
|
||||
|
||||
static char al_SetErrorHandler__doc__[] =
|
||||
""
|
||||
;
|
||||
PyDoc_STRVAR(al_SetErrorHandler__doc__, "");
|
||||
|
||||
static PyObject *
|
||||
al_SetErrorHandler(PyObject *self, PyObject *args)
|
||||
|
|
@ -2024,9 +1987,7 @@ static struct PyMethodDef al_methods[] = {
|
|||
|
||||
/* Initialization function for the module (*must* be called inital) */
|
||||
|
||||
static char al_module_documentation[] =
|
||||
""
|
||||
;
|
||||
PyDoc_STRVAR(al_module_documentation, "");
|
||||
|
||||
void
|
||||
inital(void)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue