[Bf-blender-cvs] [48c1a7f] master: Doxy cleanup: formatting

[Campbell Barton]

Commit: 48c1a7f8a45f1474c1484950687f0f30612a1731
Author: Campbell Barton
Date:   Sat May 3 23:43:36 2014 +1000
https://developer.blender.org/rB48c1a7f8a45f1474c1484950687f0f30612a1731

Doxy cleanup: formatting

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

M	source/blender/render/intern/source/bake_api.c

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

diff --git a/source/blender/render/intern/source/bake_api.c b/source/blender/render/intern/source/bake_api.c
index 7ad07e2..591e9f0 100644
--- a/source/blender/render/intern/source/bake_api.c
+++ b/source/blender/render/intern/source/bake_api.c
@@ -30,7 +30,7 @@
  *
  * The Bake API is fully implemented with Python rna functions. The operator expects/call a function:
  *
- * def  bake(scene, object, pass_type, pixel_array, num_pixels, depth, result)
+ * ``def bake(scene, object, pass_type, pixel_array, num_pixels, depth, result)``
  * - scene: current scene (Python object)
  * - object: object to render (Python object)
  * - pass_type: pass to render (string, e.g., "COMBINED", "AO", "NORMAL", ...)
@@ -44,19 +44,21 @@
  * \subsection bake_pixel BakePixel data structure
  *
  * pixel_array is a Python object storing BakePixel elements:
-
+ *
+ * <pre>
  * struct BakePixel {
  *     int primitive_id;
- *     float u, v;
- *     float dudx, dudy;
- *     float dvdx, dvdy;
+ *     float uv[2];
+ *     float du_dx, du_dy;
+ *     float dv_dx, dv_dy;
  * };
+ * </pre>
  *
  * In python you have access to:
- * - primitive_id, u, v, du_dx, du_dy, next
- * - next() is a function that returns the next BakePixel in the array.
+ * - ``primitive_id``, ``uv``, ``du_dx``, ``du_dy``, ``next``
+ * - ``next()`` is a function that returns the next #BakePixel in the array.
  *
- * \note Pixels that should not be baked have primitive_id = -1
+ * \note Pixels that should not be baked have ``primitive_id == -1``
  *
  * For a complete implementation example look at the Cycles Bake commit.
  */