diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-07-20 15:52:31 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-07-20 15:58:14 +0300 |
commit | c3a400b73fbf46f1b8cfa1a5735e2a96254974b2 (patch) | |
tree | 71d54f9f4cd25eed51a3ff20a96b29ece7979608 /source/blender/python | |
parent | 48a45c43e4902e1dd431bf1472e7b1dfb2ec64e3 (diff) |
Cleanup: use single back-tick quoting in comments
While doxygen supports both, conform to our style guide.
Note that single back-tick's are already used in a majority of comments.
Diffstat (limited to 'source/blender/python')
22 files changed, 43 insertions, 43 deletions
diff --git a/source/blender/python/generic/py_capi_utils.c b/source/blender/python/generic/py_capi_utils.c index a27ef30c849..68fefee4a61 100644 --- a/source/blender/python/generic/py_capi_utils.c +++ b/source/blender/python/generic/py_capi_utils.c @@ -525,7 +525,7 @@ PyObject *PyC_FrozenSetFromStrings(const char **strings) * * Implementation - we can't actually prepend the existing exception, * because it could have _any_ arguments given to it, so instead we get its - * ``__str__`` output and raise our own exception including it. + * `__str__` output and raise our own exception including it. */ PyObject *PyC_Err_Format_Prefix(PyObject *exception_type_prefix, const char *format, ...) { diff --git a/source/blender/python/gpu/gpu_py.c b/source/blender/python/gpu/gpu_py.c index 7aea940da94..e6ba46b2b05 100644 --- a/source/blender/python/gpu/gpu_py.c +++ b/source/blender/python/gpu/gpu_py.c @@ -17,8 +17,8 @@ /** \file * \ingroup bpygpu * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_api.c b/source/blender/python/gpu/gpu_py_api.c index 5119b3612f8..db84e03adcb 100644 --- a/source/blender/python/gpu/gpu_py_api.c +++ b/source/blender/python/gpu/gpu_py_api.c @@ -20,8 +20,8 @@ * Experimental Python API, not considered public yet (called '_gpu'), * we may re-expose as public later. * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_batch.c b/source/blender/python/gpu/gpu_py_batch.c index 5214d156adf..c0c0aa0028d 100644 --- a/source/blender/python/gpu/gpu_py_batch.c +++ b/source/blender/python/gpu/gpu_py_batch.c @@ -19,11 +19,11 @@ /** \file * \ingroup bpygpu * - * This file defines the offscreen functionalities of the 'gpu' module + * This file defines the off-screen functionalities of the 'gpu' module * used for off-screen OpenGL rendering. * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_buffer.c b/source/blender/python/gpu/gpu_py_buffer.c index 5c004459b44..a1fc89e772e 100644 --- a/source/blender/python/gpu/gpu_py_buffer.c +++ b/source/blender/python/gpu/gpu_py_buffer.c @@ -19,8 +19,8 @@ * * This file defines the gpu.state API. * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_capabilities.c b/source/blender/python/gpu/gpu_py_capabilities.c index cedce485253..f3fb93021b2 100644 --- a/source/blender/python/gpu/gpu_py_capabilities.c +++ b/source/blender/python/gpu/gpu_py_capabilities.c @@ -17,8 +17,8 @@ /** \file * \ingroup bpygpu * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_element.c b/source/blender/python/gpu/gpu_py_element.c index 0cb5e9a2785..2dd8d1c379e 100644 --- a/source/blender/python/gpu/gpu_py_element.c +++ b/source/blender/python/gpu/gpu_py_element.c @@ -17,8 +17,8 @@ /** \file * \ingroup bpygpu * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_framebuffer.c b/source/blender/python/gpu/gpu_py_framebuffer.c index 2f081fcfd8c..951e1857059 100644 --- a/source/blender/python/gpu/gpu_py_framebuffer.c +++ b/source/blender/python/gpu/gpu_py_framebuffer.c @@ -20,8 +20,8 @@ * This file defines the framebuffer functionalities of the 'gpu' module * used for off-screen OpenGL rendering. * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_matrix.c b/source/blender/python/gpu/gpu_py_matrix.c index b379600d33c..cc9b3d702e2 100644 --- a/source/blender/python/gpu/gpu_py_matrix.c +++ b/source/blender/python/gpu/gpu_py_matrix.c @@ -22,8 +22,8 @@ * \warning While these functions attempt to ensure correct stack usage. * Mixing Python and C functions may still crash on invalid use. * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_offscreen.c b/source/blender/python/gpu/gpu_py_offscreen.c index 0a8b294ea41..457f00b1267 100644 --- a/source/blender/python/gpu/gpu_py_offscreen.c +++ b/source/blender/python/gpu/gpu_py_offscreen.c @@ -22,8 +22,8 @@ * This file defines the offscreen functionalities of the 'gpu' module * used for off-screen OpenGL rendering. * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_platform.c b/source/blender/python/gpu/gpu_py_platform.c index e49ad18dfd8..132052b6f1d 100644 --- a/source/blender/python/gpu/gpu_py_platform.c +++ b/source/blender/python/gpu/gpu_py_platform.c @@ -17,8 +17,8 @@ /** \file * \ingroup bpygpu * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_select.c b/source/blender/python/gpu/gpu_py_select.c index b72aca6a792..4db102118f1 100644 --- a/source/blender/python/gpu/gpu_py_select.c +++ b/source/blender/python/gpu/gpu_py_select.c @@ -22,8 +22,8 @@ * \note Currently only used for gizmo selection, * will need to add begin/end and a way to access the hits. * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_shader.c b/source/blender/python/gpu/gpu_py_shader.c index fc3a7d1360b..00e876aee7d 100644 --- a/source/blender/python/gpu/gpu_py_shader.c +++ b/source/blender/python/gpu/gpu_py_shader.c @@ -17,8 +17,8 @@ /** \file * \ingroup bpygpu * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_state.c b/source/blender/python/gpu/gpu_py_state.c index 173c5afba56..7b7a61cc338 100644 --- a/source/blender/python/gpu/gpu_py_state.c +++ b/source/blender/python/gpu/gpu_py_state.c @@ -19,8 +19,8 @@ * * This file defines the gpu.state API. * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_texture.c b/source/blender/python/gpu/gpu_py_texture.c index 2181c09b537..ca41662db9d 100644 --- a/source/blender/python/gpu/gpu_py_texture.c +++ b/source/blender/python/gpu/gpu_py_texture.c @@ -19,8 +19,8 @@ * * This file defines the texture functionalities of the 'gpu' module * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_types.c b/source/blender/python/gpu/gpu_py_types.c index fdd589d788e..a8787cf5c7f 100644 --- a/source/blender/python/gpu/gpu_py_types.c +++ b/source/blender/python/gpu/gpu_py_types.c @@ -17,8 +17,8 @@ /** \file * \ingroup bpygpu * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_uniformbuffer.c b/source/blender/python/gpu/gpu_py_uniformbuffer.c index cfef20e2e4d..616ef65a5d1 100644 --- a/source/blender/python/gpu/gpu_py_uniformbuffer.c +++ b/source/blender/python/gpu/gpu_py_uniformbuffer.c @@ -19,8 +19,8 @@ * * This file defines the uniform buffer functionalities of the 'gpu' module * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_vertex_buffer.c b/source/blender/python/gpu/gpu_py_vertex_buffer.c index 3c7038186b9..949086378a8 100644 --- a/source/blender/python/gpu/gpu_py_vertex_buffer.c +++ b/source/blender/python/gpu/gpu_py_vertex_buffer.c @@ -17,8 +17,8 @@ /** \file * \ingroup bpygpu * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/gpu/gpu_py_vertex_format.c b/source/blender/python/gpu/gpu_py_vertex_format.c index 39c91966cab..c344429576a 100644 --- a/source/blender/python/gpu/gpu_py_vertex_format.c +++ b/source/blender/python/gpu/gpu_py_vertex_format.c @@ -17,8 +17,8 @@ /** \file * \ingroup bpygpu * - * - Use ``bpygpu_`` for local API. - * - Use ``BPyGPU`` for public API. + * - Use `bpygpu_` for local API. + * - Use `BPyGPU` for public API. */ #include <Python.h> diff --git a/source/blender/python/intern/bpy_utils_units.c b/source/blender/python/intern/bpy_utils_units.c index e5ac1ba9a95..aa8cf8f2a9f 100644 --- a/source/blender/python/intern/bpy_utils_units.c +++ b/source/blender/python/intern/bpy_utils_units.c @@ -67,7 +67,7 @@ static const char *bpyunits_ucategorie_items[] = { /** * These fields are just empty placeholders, actual values get set in initializations functions. * This allows us to avoid many handwriting, and above all, - * to keep all systems/categories definition stuff in ``BKE_unit.h``. + * to keep all systems/categories definition stuff in `BKE_unit.h`. */ static PyStructSequence_Field bpyunits_systems_fields[ARRAY_SIZE(bpyunits_usystem_items)]; static PyStructSequence_Field bpyunits_categories_fields[ARRAY_SIZE(bpyunits_ucategorie_items)]; diff --git a/source/blender/python/mathutils/mathutils.c b/source/blender/python/mathutils/mathutils.c index 16bf7120606..5beca7bd71a 100644 --- a/source/blender/python/mathutils/mathutils.c +++ b/source/blender/python/mathutils/mathutils.c @@ -78,7 +78,7 @@ static int mathutils_array_parse_fast(float *array, } /** - * helper function that returns a Python ``__hash__``. + * helper function that returns a Python `__hash__`. * * \note consistent with the equivalent tuple of floats (CPython's 'tuplehash') */ diff --git a/source/blender/python/mathutils/mathutils_Matrix.c b/source/blender/python/mathutils/mathutils_Matrix.c index 8b8130f3cc2..36b8b0b6d35 100644 --- a/source/blender/python/mathutils/mathutils_Matrix.c +++ b/source/blender/python/mathutils/mathutils_Matrix.c @@ -1174,7 +1174,7 @@ static void matrix_invert_with_det_n_internal(float *mat_dst, } /** - * \param r_mat: can be from ``self->matrix`` or not. + * \param r_mat: can be from `self->matrix` or not. */ static bool matrix_invert_internal(const MatrixObject *self, float *r_mat) { @@ -1191,8 +1191,8 @@ static bool matrix_invert_internal(const MatrixObject *self, float *r_mat) } /** - * Similar to ``matrix_invert_internal`` but should never error. - * \param r_mat: can be from ``self->matrix`` or not. + * Similar to `matrix_invert_internal` but should never error. + * \param r_mat: can be from `self->matrix` or not. */ static void matrix_invert_safe_internal(const MatrixObject *self, float *r_mat) { |