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.
This commit is contained in:
@@ -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, ...)
|
||||
{
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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)];
|
||||
|
||||
@@ -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')
|
||||
*/
|
||||
|
||||
@@ -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)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user