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/blenlib | |
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/blenlib')
24 files changed, 66 insertions, 66 deletions
diff --git a/source/blender/blenlib/BLI_array.h b/source/blender/blenlib/BLI_array.h index e40a79dad21..6bf29a6168f 100644 --- a/source/blender/blenlib/BLI_array.h +++ b/source/blender/blenlib/BLI_array.h @@ -58,7 +58,7 @@ void _bli_array_grow_func(void **arr_p, /** \name Public defines * \{ */ -/** use ``sizeof(*(arr))`` to ensure the array exists and is an array */ +/** use `sizeof(*(arr))` to ensure the array exists and is an array */ #define BLI_array_declare(arr) \ int _##arr##_len = ((void)(sizeof(*(arr))), 0); \ void *_##arr##_static = NULL diff --git a/source/blender/blenlib/BLI_color.hh b/source/blender/blenlib/BLI_color.hh index 76dfcf0b57d..d93bd7f6f76 100644 --- a/source/blender/blenlib/BLI_color.hh +++ b/source/blender/blenlib/BLI_color.hh @@ -34,11 +34,11 @@ namespace blender { * Usage: * * Convert a theme byte color to a linearrgb premultiplied. - * ``` + * \code{.cc} * ColorTheme4b theme_color; * ColorSceneLinear4f<eAlpha::Premultiplied> linearrgb_color = * BLI_color_convert_to_scene_linear(theme_color).premultiply_alpha(); - * ``` + * \endcode * * The API is structured to make most use of inlining. Most notable are space * conversions done via `BLI_color_convert_to*` functions. diff --git a/source/blender/blenlib/BLI_compiler_typecheck.h b/source/blender/blenlib/BLI_compiler_typecheck.h index d9c2bfc1d58..18be2190c1b 100644 --- a/source/blender/blenlib/BLI_compiler_typecheck.h +++ b/source/blender/blenlib/BLI_compiler_typecheck.h @@ -86,7 +86,7 @@ /** * CHECK_TYPE_ANY: handy macro, eg: - * ``CHECK_TYPE_ANY(var, Foo *, Bar *, Baz *)`` + * `CHECK_TYPE_ANY(var, Foo *, Bar *, Baz *)` * * excuse ridiculously long generated args. * \code{.py} diff --git a/source/blender/blenlib/BLI_ghash.h b/source/blender/blenlib/BLI_ghash.h index e708b327bd4..a2c5c6349a5 100644 --- a/source/blender/blenlib/BLI_ghash.h +++ b/source/blender/blenlib/BLI_ghash.h @@ -77,7 +77,7 @@ enum { /* -------------------------------------------------------------------- */ /** \name GHash API * - * Defined in ``BLI_ghash.c`` + * Defined in `BLI_ghash.c` * \{ */ GHash *BLI_ghash_new_ex(GHashHashFP hashfp, @@ -333,11 +333,11 @@ double BLI_gset_calc_quality(GSet *gs); /* -------------------------------------------------------------------- */ /** \name GHash/GSet Utils * - * Defined in ``BLI_ghash_utils.c`` + * Defined in `BLI_ghash_utils.c` * \{ */ /** - * Callbacks for GHash (``BLI_ghashutil_``) + * Callbacks for GHash (`BLI_ghashutil_`) * * \note '_p' suffix denotes void pointer arg, * so we can have functions that take correctly typed args too. diff --git a/source/blender/blenlib/BLI_link_utils.h b/source/blender/blenlib/BLI_link_utils.h index e1e4a8dbd4a..7aa7300da16 100644 --- a/source/blender/blenlib/BLI_link_utils.h +++ b/source/blender/blenlib/BLI_link_utils.h @@ -20,7 +20,7 @@ * \ingroup bli * \brief Single link-list utility macros. (header only api). * - * Use this api when the structure defines its own ``next`` pointer + * Use this api when the structure defines its own `next` pointer * and a double linked list such as #ListBase isn't needed. */ diff --git a/source/blender/blenlib/BLI_linklist_stack.h b/source/blender/blenlib/BLI_linklist_stack.h index 8a5e94a7b56..d07bc40c923 100644 --- a/source/blender/blenlib/BLI_linklist_stack.h +++ b/source/blender/blenlib/BLI_linklist_stack.h @@ -28,7 +28,7 @@ * \note These macros follow STACK_* macros defined in 'BLI_utildefines.h' * and should be kept (mostly) interchangeable. * - * \note ``_##var##_type`` is a dummy variable only used for typechecks. + * \note `_##var##_type` is a dummy variable only used for type-checks. */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenlib/BLI_math.h b/source/blender/blenlib/BLI_math.h index 3b61c0feb51..5768b098d2f 100644 --- a/source/blender/blenlib/BLI_math.h +++ b/source/blender/blenlib/BLI_math.h @@ -26,32 +26,32 @@ * * \section mathabbrev Abbreviations * - * - ``fl`` = float - * - ``db`` = double - * - ``v2`` = vec2 = vector 2 - * - ``v3`` = vec3 = vector 3 - * - ``v4`` = vec4 = vector 4 - * - ``vn`` = vec4 = vector N dimensions, *passed as an arg, after the vector*. - * - ``qt`` = quat = quaternion - * - ``dq`` = dquat = dual quaternion - * - ``m2`` = mat2 = matrix 2x2 - * - ``m3`` = mat3 = matrix 3x3 - * - ``m4`` = mat4 = matrix 4x4 - * - ``eul`` = euler rotation - * - ``eulO`` = euler with order - * - ``plane`` = plane 4, (vec3, distance) - * - ``plane3`` = plane 3 (same as a ``plane`` with a zero 4th component) + * - `fl` = float + * - `db` = double + * - `v2` = vec2 = vector 2 + * - `v3` = vec3 = vector 3 + * - `v4` = vec4 = vector 4 + * - `vn` = vec4 = vector N dimensions, *passed as an arg, after the vector*. + * - `qt` = quat = quaternion + * - `dq` = dquat = dual quaternion + * - `m2` = mat2 = matrix 2x2 + * - `m3` = mat3 = matrix 3x3 + * - `m4` = mat4 = matrix 4x4 + * - `eul` = euler rotation + * - `eulO` = euler with order + * - `plane` = plane 4, (vec3, distance) + * - `plane3` = plane 3 (same as a `plane` with a zero 4th component) * * \subsection mathabbrev_all Function Type Abbreviations * * For non float versions of functions (which typically operate on floats), * use single suffix abbreviations. * - * - ``_d`` = double - * - ``_i`` = int - * - ``_u`` = unsigned int - * - ``_char`` = char - * - ``_uchar`` = unsigned char + * - `_d` = double + * - `_i` = int + * - `_u` = unsigned int + * - `_char` = char + * - `_uchar` = unsigned char * * \section mathvarnames Variable Names * diff --git a/source/blender/blenlib/intern/BLI_dynstr.c b/source/blender/blenlib/intern/BLI_dynstr.c index 86784557b25..8f7f722c71b 100644 --- a/source/blender/blenlib/intern/BLI_dynstr.c +++ b/source/blender/blenlib/intern/BLI_dynstr.c @@ -291,7 +291,7 @@ int BLI_dynstr_get_len(const DynStr *ds) /** * Get a DynStr's contents as a c-string. * The \a rets argument must be allocated to be at - * least the size of ``BLI_dynstr_get_len(ds) + 1``. + * least the size of `BLI_dynstr_get_len(ds) + 1`. * * \param ds: The DynStr of interest. * \param rets: The string to fill. diff --git a/source/blender/blenlib/intern/BLI_ghash.c b/source/blender/blenlib/intern/BLI_ghash.c index 46e599b7cf3..2c9285e418a 100644 --- a/source/blender/blenlib/intern/BLI_ghash.c +++ b/source/blender/blenlib/intern/BLI_ghash.c @@ -1270,7 +1270,7 @@ void BLI_gset_flag_clear(GSet *gs, uint flag) /* -------------------------------------------------------------------- */ /** \name GSet Combined Key/Value Usage * - * \note Not typical ``set`` use, only use when the pointer identity matters. + * \note Not typical `set` use, only use when the pointer identity matters. * This can be useful when the key references data stored outside the GSet. * \{ */ diff --git a/source/blender/blenlib/intern/BLI_ghash_utils.c b/source/blender/blenlib/intern/BLI_ghash_utils.c index 182c27aed6d..b9144009304 100644 --- a/source/blender/blenlib/intern/BLI_ghash_utils.c +++ b/source/blender/blenlib/intern/BLI_ghash_utils.c @@ -138,8 +138,8 @@ size_t BLI_ghashutil_combine_hash(size_t hash_a, size_t hash_b) * This function implements the widely used "djb" hash apparently posted * by Daniel Bernstein to comp.lang.c some time ago. The 32 bit * unsigned hash value starts at 5381 and for each byte 'c' in the - * string, is updated: ``hash = hash * 33 + c``. This - * function uses the signed value of each byte. + * string, is updated: `hash = hash * 33 + c`. + * This function uses the signed value of each byte. * * NOTE: this is the same hash method that glib 2.34.0 uses. */ diff --git a/source/blender/blenlib/intern/BLI_kdopbvh.c b/source/blender/blenlib/intern/BLI_kdopbvh.c index 25939323b73..3af942cd6d0 100644 --- a/source/blender/blenlib/intern/BLI_kdopbvh.c +++ b/source/blender/blenlib/intern/BLI_kdopbvh.c @@ -868,7 +868,7 @@ static void non_recursive_bvh_div_nodes(const BVHTree *tree, * \{ */ /** - * \note many callers don't check for ``NULL`` return. + * \note many callers don't check for `NULL` return. */ BVHTree *BLI_bvhtree_new(int maxsize, float epsilon, char tree_type, char axis) { diff --git a/source/blender/blenlib/intern/BLI_memiter.c b/source/blender/blenlib/intern/BLI_memiter.c index 3f255ce0e16..effbe5da5c4 100644 --- a/source/blender/blenlib/intern/BLI_memiter.c +++ b/source/blender/blenlib/intern/BLI_memiter.c @@ -73,7 +73,7 @@ typedef struct BLI_memiter_chunk { struct BLI_memiter_chunk *next; /** * internal format is: - * ``[next_pointer, size:data, size:data, ..., negative_offset]`` + * `[next_pointer, size:data, size:data, ..., negative_offset]` * * Where negative offset rewinds to the start. */ diff --git a/source/blender/blenlib/intern/BLI_mempool.c b/source/blender/blenlib/intern/BLI_mempool.c index 5263af2ae56..f968799326a 100644 --- a/source/blender/blenlib/intern/BLI_mempool.c +++ b/source/blender/blenlib/intern/BLI_mempool.c @@ -63,9 +63,9 @@ #endif /** - * Important that this value is an is _not_ aligned with ``sizeof(void *)``. + * Important that this value is an is _not_ aligned with `sizeof(void *)`. * So having a pointer to 2/4/8... aligned memory is enough to ensure - * the freeword will never be used. + * the `freeword` will never be used. * To be safe, use a word that's the same in both directions. */ #define FREEWORD \ diff --git a/source/blender/blenlib/intern/array_store.c b/source/blender/blenlib/intern/array_store.c index e1a7ee98ce5..5ad57a7bec8 100644 --- a/source/blender/blenlib/intern/array_store.c +++ b/source/blender/blenlib/intern/array_store.c @@ -1403,16 +1403,16 @@ static BChunkList *bchunk_list_from_data_merge(const BArrayInfo *info, * Create a new array store, which can store any number of arrays * as long as their stride matches. * - * \param stride: ``sizeof()`` each element, + * \param stride: `sizeof()` each element, * - * \note while a stride of ``1`` will always work, + * \note while a stride of `1` will always work, * its less efficient since duplicate chunks of memory will be searched * at positions unaligned with the array data. * * \param chunk_count: Number of elements to split each chunk into. * - A small value increases the ability to de-duplicate chunks, * but adds overhead by increasing the number of chunks to look up when searching for duplicates, - * as well as some overhead constructing the original array again, with more calls to ``memcpy``. + * as well as some overhead constructing the original array again, with more calls to `memcpy`. * - Larger values reduce the *book keeping* overhead, * but increase the chance a small, * isolated change will cause a larger amount of data to be duplicated. diff --git a/source/blender/blenlib/intern/convexhull_2d.c b/source/blender/blenlib/intern/convexhull_2d.c index cb4ef54bfb7..233a1430fe7 100644 --- a/source/blender/blenlib/intern/convexhull_2d.c +++ b/source/blender/blenlib/intern/convexhull_2d.c @@ -188,7 +188,7 @@ static int pointref_cmp_yx(const void *a_, const void *b_) * \param points: An array of 2D points. * \param n: The number of points in points. * \param r_points: An array of the convex hull vertex indices (max is n). - * _must_ be allocated as ``n * 2`` because of how its used internally, + * _must_ be allocated as `n * 2` because of how its used internally, * even though the final result will be no more than \a n in size. * \returns the number of points in r_points. */ diff --git a/source/blender/blenlib/intern/math_color_inline.c b/source/blender/blenlib/intern/math_color_inline.c index 4c50c1c7af8..a5a687ef9fe 100644 --- a/source/blender/blenlib/intern/math_color_inline.c +++ b/source/blender/blenlib/intern/math_color_inline.c @@ -276,14 +276,14 @@ MINLINE void cpack_cpy_3ub(unsigned char r_col[3], const unsigned int pack) * https://en.wikipedia.org/wiki/Relative_luminance * * Real values are: - * ``Y = 0.2126390059(R) + 0.7151686788(G) + 0.0721923154(B)`` + * `Y = 0.2126390059(R) + 0.7151686788(G) + 0.0721923154(B)` * according to: "Derivation of Basic Television Color Equations", RP 177-1993 * * As this sums slightly above 1.0, the document recommends to use: - * ``0.2126(R) + 0.7152(G) + 0.0722(B)``, as used here. + * `0.2126(R) + 0.7152(G) + 0.0722(B)`, as used here. * * The high precision values are used to calculate the rounded byte weights so they add up to 255: - * ``54(R) + 182(G) + 19(B)`` + * `54(R) + 182(G) + 19(B)` */ MINLINE float rgb_to_grayscale(const float rgb[3]) { diff --git a/source/blender/blenlib/intern/math_geom.c b/source/blender/blenlib/intern/math_geom.c index 80f0008c7eb..803291e4a3b 100644 --- a/source/blender/blenlib/intern/math_geom.c +++ b/source/blender/blenlib/intern/math_geom.c @@ -165,7 +165,7 @@ float area_squared_poly_v3(const float verts[][3], unsigned int nr) /** * Scalar cross product of a 2d polygon. * - * - equivalent to ``area * 2`` + * - equivalent to `area * 2` * - useful for checking polygon winding (a positive value is clockwise). */ float cross_poly_v2(const float verts[][2], unsigned int nr) @@ -518,7 +518,7 @@ float dist_to_line_v3(const float p[3], const float l1[3], const float l2[3]) } /** - * Check if \a p is inside the 2x planes defined by ``(v1, v2, v3)`` + * Check if \a p is inside the 2x planes defined by `(v1, v2, v3)` * where the 3x points define 2x planes. * * \param axis_ref: used when v1,v2,v3 form a line and to check if the corner is concave/convex. @@ -527,7 +527,7 @@ float dist_to_line_v3(const float p[3], const float l1[3], const float l2[3]) * (it just defines the planes). * * \return the lowest squared distance to either of the planes. - * where ``(return < 0.0)`` is outside. + * where `(return < 0.0)` is outside. * * <pre> * v1 @@ -1421,7 +1421,7 @@ int isect_seg_seg_v2_lambda_mu_db(const double v1[2], * \return r_p1, r_p2: Intersection coordinates. * * \note The order of assignment for intersection points (\a r_p1, \a r_p2) is predictable, - * based on the direction defined by ``l2 - l1``, + * based on the direction defined by `l2 - l1`, * this direction compared with the normal of each point on the sphere: * \a r_p1 always has a >= 0.0 dot product. * \a r_p2 always has a <= 0.0 dot product. @@ -3426,7 +3426,7 @@ float ray_point_factor_v3(const float p[3], /** * A simplified version of #closest_to_line_v3 - * we only need to return the ``lambda`` + * we only need to return the `lambda` * * \param epsilon: avoid approaching divide-by-zero. * Passing a zero will just check for nonzero division. diff --git a/source/blender/blenlib/intern/math_geom_inline.c b/source/blender/blenlib/intern/math_geom_inline.c index 655d3fcc4c0..1757b0dd525 100644 --- a/source/blender/blenlib/intern/math_geom_inline.c +++ b/source/blender/blenlib/intern/math_geom_inline.c @@ -272,7 +272,7 @@ MINLINE float shell_angle_to_dist(const float angle) return (UNLIKELY(angle < SMALL_NUMBER)) ? 1.0f : fabsf(1.0f / cosf(angle)); } /** - * equivalent to ``shell_angle_to_dist(angle_normalized_v3v3(a, b))`` + * Equivalent to `shell_angle_to_dist(angle_normalized_v3v3(a, b))`. */ MINLINE float shell_v3v3_normalized_to_dist(const float a[3], const float b[3]) { @@ -282,7 +282,7 @@ MINLINE float shell_v3v3_normalized_to_dist(const float a[3], const float b[3]) return (UNLIKELY(angle_cos < SMALL_NUMBER)) ? 1.0f : (1.0f / angle_cos); } /** - * equivalent to ``shell_angle_to_dist(angle_normalized_v2v2(a, b))`` + * Equivalent to `shell_angle_to_dist(angle_normalized_v2v2(a, b))`. */ MINLINE float shell_v2v2_normalized_to_dist(const float a[2], const float b[2]) { @@ -293,7 +293,7 @@ MINLINE float shell_v2v2_normalized_to_dist(const float a[2], const float b[2]) } /** - * equivalent to ``shell_angle_to_dist(angle_normalized_v3v3(a, b) / 2)`` + * Equivalent to `shell_angle_to_dist(angle_normalized_v3v3(a, b) / 2)`. */ MINLINE float shell_v3v3_mid_normalized_to_dist(const float a[3], const float b[3]) { @@ -307,7 +307,7 @@ MINLINE float shell_v3v3_mid_normalized_to_dist(const float a[3], const float b[ } /** - * equivalent to ``shell_angle_to_dist(angle_normalized_v2v2(a, b) / 2)`` + * Equivalent to `shell_angle_to_dist(angle_normalized_v2v2(a, b) / 2)`. */ MINLINE float shell_v2v2_mid_normalized_to_dist(const float a[2], const float b[2]) { diff --git a/source/blender/blenlib/intern/math_vector_inline.c b/source/blender/blenlib/intern/math_vector_inline.c index db9ece81c59..55f7a152b83 100644 --- a/source/blender/blenlib/intern/math_vector_inline.c +++ b/source/blender/blenlib/intern/math_vector_inline.c @@ -1312,7 +1312,7 @@ MINLINE bool is_one_v3(const float v[3]) /* -------------------------------------------------------------------- */ /** \name Vector Comparison * - * \note use ``value <= limit``, so a limit of zero doesn't fail on an exact match. + * \note use `value <= limit`, so a limit of zero doesn't fail on an exact match. * \{ */ MINLINE bool equals_v2v2(const float v1[2], const float v2[2]) diff --git a/source/blender/blenlib/intern/memory_utils.c b/source/blender/blenlib/intern/memory_utils.c index 5ca7b96c136..4bb93877401 100644 --- a/source/blender/blenlib/intern/memory_utils.c +++ b/source/blender/blenlib/intern/memory_utils.c @@ -19,7 +19,7 @@ * \brief Generic memory manipulation API. * * This is to extend on existing functions - * such as ``memcpy`` & ``memcmp``. + * such as `memcpy` & `memcmp`. */ #include <string.h> diff --git a/source/blender/blenlib/intern/polyfill_2d.c b/source/blender/blenlib/intern/polyfill_2d.c index 817572ba85c..9af98359199 100644 --- a/source/blender/blenlib/intern/polyfill_2d.c +++ b/source/blender/blenlib/intern/polyfill_2d.c @@ -77,9 +77,9 @@ typedef signed char eSign; #ifdef USE_KDTREE /** * Spatial optimization for point-in-triangle intersection checks. - * The simple version of this algorithm is ``O(n^2)`` complexity + * The simple version of this algorithm is `O(n^2)` complexity * (every point needing to check the triangle defined by every other point), - * Using a binary-tree reduces the complexity to ``O(n log n)`` + * Using a binary-tree reduces the complexity to `O(n log n)` * plus some overhead of creating the tree. * * This is a single purpose KDTree based on BLI_kdtree with some modifications @@ -898,7 +898,7 @@ void BLI_polyfill_calc_arena(const float (*coords)[2], * \param coords_sign: Pass this when we know the sign in advance to avoid extra calculations. * * \param r_tris: This array is filled in with triangle indices in clockwise order. - * The length of the array must be ``coords_tot - 2``. + * The length of the array must be `coords_tot - 2`. * Indices are guaranteed to be assigned to unique triangles, with valid indices, * even in the case of degenerate input (self intersecting polygons, zero area ears... etc). */ diff --git a/source/blender/blenlib/intern/smallhash.c b/source/blender/blenlib/intern/smallhash.c index 6e5a3e961a5..006a3798dcd 100644 --- a/source/blender/blenlib/intern/smallhash.c +++ b/source/blender/blenlib/intern/smallhash.c @@ -34,11 +34,11 @@ * Otherwise #GHash should be used instead. * * #SmallHashEntry.key - * - ``SMHASH_KEY_UNUSED`` means the key in the cell has not been initialized. + * - `SMHASH_KEY_UNUSED` means the key in the cell has not been initialized. * * #SmallHashEntry.val - * - ``SMHASH_CELL_UNUSED`` means this cell is inside a key series. - * - ``SMHASH_CELL_FREE`` means this cell terminates a key series. + * - `SMHASH_CELL_UNUSED` means this cell is inside a key series. + * - `SMHASH_CELL_FREE` means this cell terminates a key series. * * Note that the values and keys are often pointers or index values, * use the maximum values to avoid real pointers colliding with magic numbers. diff --git a/source/blender/blenlib/intern/string.c b/source/blender/blenlib/intern/string.c index 61d095658a3..5541d75bc73 100644 --- a/source/blender/blenlib/intern/string.c +++ b/source/blender/blenlib/intern/string.c @@ -232,7 +232,7 @@ size_t BLI_vsnprintf(char *__restrict buffer, } /** - * A version of #BLI_vsnprintf that returns ``strlen(buffer)`` + * A version of #BLI_vsnprintf that returns `strlen(buffer)` */ size_t BLI_vsnprintf_rlen(char *__restrict buffer, size_t maxncpy, @@ -278,7 +278,7 @@ size_t BLI_snprintf(char *__restrict dst, size_t maxncpy, const char *__restrict } /** - * A version of #BLI_snprintf that returns ``strlen(dst)`` + * A version of #BLI_snprintf that returns `strlen(dst)` */ size_t BLI_snprintf_rlen(char *__restrict dst, size_t maxncpy, const char *__restrict format, ...) { diff --git a/source/blender/blenlib/intern/timecode.c b/source/blender/blenlib/intern/timecode.c index 7d7436411ac..a9665c0a9c2 100644 --- a/source/blender/blenlib/intern/timecode.c +++ b/source/blender/blenlib/intern/timecode.c @@ -39,7 +39,7 @@ * Generate time-code/frame number string and store in \a str * * \param str: destination string - * \param maxncpy: maximum number of characters to copy ``sizeof(str)`` + * \param maxncpy: maximum number of characters to copy `sizeof(str)` * \param brevity_level: special setting for #View2D grid drawing, * used to specify how detailed we need to be * \param time_seconds: time total time in seconds @@ -199,7 +199,7 @@ size_t BLI_timecode_string_from_time(char *str, * Generate time string and store in \a str * * \param str: destination string - * \param maxncpy: maximum number of characters to copy ``sizeof(str)`` + * \param maxncpy: maximum number of characters to copy `sizeof(str)` * \param time_seconds: time total time in seconds * \return length of \a str */ @@ -229,7 +229,7 @@ size_t BLI_timecode_string_from_time_simple(char *str, * Generate time string and store in \a str * * \param str: destination string - * \param maxncpy: maximum number of characters to copy ``sizeof(str)`` + * \param maxncpy: maximum number of characters to copy `sizeof(str)` * \param brevity_level: special setting for #View2D grid drawing, * used to specify how detailed we need to be * \param time_seconds: time total time in seconds |