[Bf-blender-cvs] [2af9053] master: cleanup: doxy comments

Campbell Barton noreply at git.blender.org
Sat Feb 14 00:27:44 CET 2015


Commit: 2af905391d6c5e238751b0dd4ce9f766668fcea2
Author: Campbell Barton
Date:   Sat Feb 14 07:28:31 2015 +1100
Branches: master
https://developer.blender.org/rB2af905391d6c5e238751b0dd4ce9f766668fcea2

cleanup: doxy comments

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

M	source/blender/blenlib/BLI_buffer.h
M	source/blender/blenlib/BLI_compiler_typecheck.h
M	source/blender/blenlib/BLI_dial.h
M	source/blender/blenlib/BLI_utildefines.h
M	source/blender/render/intern/source/bake_api.c
M	source/blender/windowmanager/WM_types.h

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

diff --git a/source/blender/blenlib/BLI_buffer.h b/source/blender/blenlib/BLI_buffer.h
index 700abca..4e5b61d 100644
--- a/source/blender/blenlib/BLI_buffer.h
+++ b/source/blender/blenlib/BLI_buffer.h
@@ -29,7 +29,7 @@
  * declared in since.
  *
  * Usage examples:
- * \code
+ * \code{.c}
  * BLI_buffer_declare_static(int, my_int_array, BLI_BUFFER_NOP, 32);
  *
  * BLI_buffer_append(my_int_array, int, 42);
diff --git a/source/blender/blenlib/BLI_compiler_typecheck.h b/source/blender/blenlib/BLI_compiler_typecheck.h
index 46c5777..652c4a9 100644
--- a/source/blender/blenlib/BLI_compiler_typecheck.h
+++ b/source/blender/blenlib/BLI_compiler_typecheck.h
@@ -81,12 +81,12 @@
  * ``CHECK_TYPE_ANY(var, Foo *, Bar *, Baz *)``
  *
  * excuse ridiculously long generated args.
- * <pre>
+ * \code{.py}
  * for i in range(63):
  *     args = [(chr(ord('a') + (c % 26)) + (chr(ord('0') + (c // 26)))) for c in range(i + 1)]
  *     print("#define _VA_CHECK_TYPE_ANY%d(v, %s) \\" % (i + 2, ", ".join(args)))
  *     print("    ((void)_Generic((v), %s))" % (": 0, ".join(args) + ": 0"))
- * </pre>
+ * \endcode
  */
 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
 
diff --git a/source/blender/blenlib/BLI_dial.h b/source/blender/blenlib/BLI_dial.h
index c8b57e8..ad7680f 100644
--- a/source/blender/blenlib/BLI_dial.h
+++ b/source/blender/blenlib/BLI_dial.h
@@ -34,7 +34,8 @@
  * current and previous directions of the digit, and returned to the user.
  * 
  * Usage examples:
- * \code
+ *
+ * \code{.c}
  * float start_position[2] = {0.0f, 0.0f};
  * float current_position[2];
  * float threshold = 0.5f;
@@ -46,7 +47,6 @@
  * angle = BLI_dial_angle(dial, curent_position);
  * 
  * MEM_freeN(dial);
- *
  * \endcode
  */
 
diff --git a/source/blender/blenlib/BLI_utildefines.h b/source/blender/blenlib/BLI_utildefines.h
index c91bedc..079352f 100644
--- a/source/blender/blenlib/BLI_utildefines.h
+++ b/source/blender/blenlib/BLI_utildefines.h
@@ -541,14 +541,13 @@ extern "C" {
 /**
  * UNUSED_VARS#(a, ...): quiet unused warnings
  *
- * <pre>
+ * \code{.py}
  * for i in range(16):
  *     args = [(chr(ord('a') + (c % 26)) + (chr(ord('0') + (c // 26)))) for c in range(i + 1)]
  *     print("#define _VA_UNUSED_VARS_%d(%s) \\" % (i + 1, ", ".join(args)))
  *     print("\t((void)(%s)%s)" %
  *             (args[0], ((", _VA_UNUSED_VARS_" + str(i) + "(%s)") if i else "%s") % ", ".join((args[1:]))))
- * </pre>
- *
+ * \endcode
  */
 
 #define _VA_UNUSED_VARS_1(a0) \
diff --git a/source/blender/render/intern/source/bake_api.c b/source/blender/render/intern/source/bake_api.c
index 48ef291..ab680cb 100644
--- a/source/blender/render/intern/source/bake_api.c
+++ b/source/blender/render/intern/source/bake_api.c
@@ -45,14 +45,14 @@
  *
  * pixel_array is a Python object storing BakePixel elements:
  *
- * <pre>
+ * \code{.c}
  * struct BakePixel {
  *     int primitive_id;
  *     float uv[2];
  *     float du_dx, du_dy;
  *     float dv_dx, dv_dy;
  * };
- * </pre>
+ * \endcode
  *
  * In python you have access to:
  * - ``primitive_id``, ``uv``, ``du_dx``, ``du_dy``, ``next``
diff --git a/source/blender/windowmanager/WM_types.h b/source/blender/windowmanager/WM_types.h
index fc1bc48..0e3e65d 100644
--- a/source/blender/windowmanager/WM_types.h
+++ b/source/blender/windowmanager/WM_types.h
@@ -94,12 +94,12 @@
  * </pre>
  *
  * A common way to get the space from the ScrArea:
- * <pre>
- *     if (sa->spacetype == SPACE_VIEW3D) {
- *         View3D *v3d = sa->spacedata.first;
- *         ...
- *     }
- * </pre>
+ * \code{.c}
+ * if (sa->spacetype == SPACE_VIEW3D) {
+ *     View3D *v3d = sa->spacedata.first;
+ *     ...
+ * }
+ * \endcode
  */
 
 #ifdef __cplusplus




More information about the Bf-blender-cvs mailing list