[Bf-blender-cvs] [3f478f4260e] blender2.8: Py API Docs: GPUIndexBuf documentation

Jacques Lucke noreply at git.blender.org
Tue Nov 13 15:26:08 CET 2018


Commit: 3f478f4260ef0ea2db27e5008c193dfec3288749
Author: Jacques Lucke
Date:   Tue Nov 13 13:33:09 2018 +0100
Branches: blender2.8
https://developer.blender.org/rB3f478f4260ef0ea2db27e5008c193dfec3288749

Py API Docs: GPUIndexBuf documentation

===================================================================

M	source/blender/python/gpu/gpu_py_api.c
M	source/blender/python/gpu/gpu_py_element.c

===================================================================

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)



More information about the Bf-blender-cvs mailing list