From 3f478f4260ef0ea2db27e5008c193dfec3288749 Mon Sep 17 00:00:00 2001 From: Jacques Lucke Date: Tue, 13 Nov 2018 13:33:09 +0100 Subject: Py API Docs: GPUIndexBuf documentation --- source/blender/python/gpu/gpu_py_api.c | 2 +- source/blender/python/gpu/gpu_py_element.c | 19 ++++++++++--------- 2 files changed, 11 insertions(+), 10 deletions(-) (limited to 'source/blender/python/gpu') diff --git a/source/blender/python/gpu/gpu_py_api.c b/source/blender/python/gpu/gpu_py_api.c index 3fad5425a6c..373bce160b7 100644 --- a/source/blender/python/gpu/gpu_py_api.c +++ b/source/blender/python/gpu/gpu_py_api.c @@ -50,9 +50,9 @@ PyDoc_STRVAR(GPU_doc, " :maxdepth: 1\n" "\n" " gpu.types.rst\n" +" gpu.shader.rst\n" " gpu.matrix.rst\n" " gpu.select.rst\n" -" gpu.shader.rst\n" "\n" ); static struct PyModuleDef GPU_module_def = { diff --git a/source/blender/python/gpu/gpu_py_element.c b/source/blender/python/gpu/gpu_py_element.c index 2462c222146..c85d6dfbe3b 100644 --- a/source/blender/python/gpu/gpu_py_element.c +++ b/source/blender/python/gpu/gpu_py_element.c @@ -198,17 +198,18 @@ static void bpygpu_IndexBuf_dealloc(BPyGPUIndexBuf *self) PyDoc_STRVAR(py_gpu_element_doc, "GPUIndexBuf(type, seq)\n" "\n" -"Contains a VBO." +"Contains an index buffer." "\n" -" :param prim_type:\n" +" :param type:\n" " One of these primitive types: {\n" -" 'POINTS',\n" -" 'LINES',\n" -" 'TRIS',\n" -" 'LINE_STRIP_ADJ'}\n" -" :type type: `str`\n" -" :param seq: Sequence of integers.\n" -" :type buf: `Any 1D or 2D Sequence`\n" +" `POINTS`,\n" +" `LINES`,\n" +" `TRIS`,\n" +" `LINE_STRIP_ADJ` }\n" +" :type type: :class:`str`\n" +" :param seq: Indices this index buffer will contain.\n" +" :type buf: 1D or 2D sequence, depending on the type. \n" +" Optionally the sequence can support the buffer protocol. \n" ); PyTypeObject BPyGPUIndexBuf_Type = { PyVarObject_HEAD_INIT(NULL, 0) -- cgit v1.2.3