[Bf-blender-cvs] [f5989b6] framebuffer: Use Py formatting for GPUOffscreen class

[Campbell Barton]

Commit: f5989b69dd299023aebc646cdaef1fabe7578532
Author: Campbell Barton
Date:   Tue Oct 20 03:01:30 2015 +1100
Branches: framebuffer
https://developer.blender.org/rBf5989b69dd299023aebc646cdaef1fabe7578532

Use Py formatting for GPUOffscreen class

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

M	source/blender/python/intern/gpu_offscreen.c

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

diff --git a/source/blender/python/intern/gpu_offscreen.c b/source/blender/python/intern/gpu_offscreen.c
index e6371fe..e1a3b57 100644
--- a/source/blender/python/intern/gpu_offscreen.c
+++ b/source/blender/python/intern/gpu_offscreen.c
@@ -297,8 +297,9 @@ static struct PyMethodDef bpy_gpu_offscreen_methods[] = {
 };
 
 PyDoc_STRVAR(py_gpu_offscreen_doc,
-"GPUOffscreen(width, height, samples) -> new GPU Offscreen object\n"
-"initialized to hold a framebuffer object of ``width`` x ``height`` with ``samples``.\n"
+".. class:: GPUOffscreen(width, height, samples)"
+"\n"
+"   This object gives access to off screen buffers.\n"
 );
 static PyTypeObject PyGPUOffScreen_Type = {
 	PyVarObject_HEAD_INIT(NULL, 0)
@@ -366,14 +367,14 @@ PyDoc_STRVAR(pygpu_offscreen_new_doc,
 "\n"
 "   Return a GPUOffScreen.\n"
 "\n"
-"   :param width: Horizontal dimension of the buffer\n"
+"   :param width: Horizontal dimension of the buffer.\n"
 "   :type width: int`\n"
-"   :param width: Vertical dimension of the buffer\n"
+"   :param width: Vertical dimension of the buffer.\n"
 "   :type width: int`\n"
-"   :param samples: OpenGL samples\n"
+"   :param samples: OpenGL samples to use for MSAA or zero to disable multi-sampling.\n"
 "   :type samples: int\n"
-"   :return: struct with GPUFrameBuffer, GPUTexture, GPUTexture.\n"
-"   :rtype: :class:`gpu.OffScreenObject`\n"
+"   :return: Newly created off-screen buffer.\n"
+"   :rtype: :class:`GPUOffscreen`\n"
 );
 static PyObject *pygpu_offscreen_new(PyObject *UNUSED(self), PyObject *args, PyObject *kwds)
 {