Docs: doxy corrections
This commit is contained in:
parent
12b7850d4f
commit
03f00eb91d
|
@ -134,7 +134,7 @@ void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
|
||||||
/**
|
/**
|
||||||
* Get reference counter.
|
* Get reference counter.
|
||||||
*
|
*
|
||||||
* @param This "This" pointer, handle of object
|
* @param handle of object
|
||||||
*/
|
*/
|
||||||
|
|
||||||
int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
|
int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
|
||||||
|
|
|
@ -37,7 +37,7 @@
|
||||||
* \note These macros follow STACK_* macros defined in 'BLI_utildefines.h'
|
* \note These macros follow STACK_* macros defined in 'BLI_utildefines.h'
|
||||||
* and should be kept (mostly) interchangeable.
|
* and should be kept (mostly) interchangeable.
|
||||||
*
|
*
|
||||||
* \note _##var##_type is a dummy var only used for typechecks.
|
* \note ``_##var##_type`` is a dummy variable only used for typechecks.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* -------------------------------------------------------------------- */
|
/* -------------------------------------------------------------------- */
|
||||||
|
|
|
@ -32,7 +32,7 @@
|
||||||
* (a queue for fixed length generally small) structures.
|
* (a queue for fixed length generally small) structures.
|
||||||
*
|
*
|
||||||
* \note Only use this if you need (first-in-first-out),
|
* \note Only use this if you need (first-in-first-out),
|
||||||
* otherwise #BLI_stack is more efficient (first-in-last-out).
|
* otherwise #BLI_Stack is more efficient (first-in-last-out).
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
|
|
|
@ -107,7 +107,8 @@
|
||||||
* \subsection bm_iter_api Iterator API
|
* \subsection bm_iter_api Iterator API
|
||||||
*
|
*
|
||||||
* Most topological queries in BMesh go through an iterator API (see Queries above).
|
* Most topological queries in BMesh go through an iterator API (see Queries above).
|
||||||
* These are defined in bmesh_iterators.h. If you can, please use the #BM_ITER macro in bmesh_iterators.h
|
* These are defined in bmesh_iterators.h.
|
||||||
|
* If you can, please use the #BM_ITER_MESH, #BM_ITER_ELEM macros in bmesh_iterators.h
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
* \subsection bm_walker_api Walker API
|
* \subsection bm_walker_api Walker API
|
||||||
|
@ -161,7 +162,7 @@
|
||||||
* - integer - #BMO_OP_SLOT_INT
|
* - integer - #BMO_OP_SLOT_INT
|
||||||
* - boolean - #BMO_OP_SLOT_BOOL
|
* - boolean - #BMO_OP_SLOT_BOOL
|
||||||
* - float - #BMO_OP_SLOT_FLT
|
* - float - #BMO_OP_SLOT_FLT
|
||||||
* - pointer - #BMO_OP_SLOT_PNT
|
* - pointer - #BMO_OP_SLOT_PTR
|
||||||
* - matrix - #BMO_OP_SLOT_MAT
|
* - matrix - #BMO_OP_SLOT_MAT
|
||||||
* - vector - #BMO_OP_SLOT_VEC
|
* - vector - #BMO_OP_SLOT_VEC
|
||||||
* - buffer - #BMO_OP_SLOT_ELEMENT_BUF - a list of verts/edges/faces.
|
* - buffer - #BMO_OP_SLOT_ELEMENT_BUF - a list of verts/edges/faces.
|
||||||
|
|
|
@ -99,7 +99,7 @@ static float bm_face_calc_poly_normal(const BMFace *f, float n[3])
|
||||||
/**
|
/**
|
||||||
* \brief COMPUTE POLY NORMAL (BMFace)
|
* \brief COMPUTE POLY NORMAL (BMFace)
|
||||||
*
|
*
|
||||||
* Same as #calc_poly_normal and #bm_face_calc_poly_normal
|
* Same as #bm_face_calc_poly_normal
|
||||||
* but takes an array of vertex locations.
|
* but takes an array of vertex locations.
|
||||||
*/
|
*/
|
||||||
static float bm_face_calc_poly_normal_vertex_cos(
|
static float bm_face_calc_poly_normal_vertex_cos(
|
||||||
|
|
|
@ -133,7 +133,7 @@ Object *ED_view3d_cameracontrol_object_get(View3DCameraControl *vctrl)
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a #View3DControl handle and sets up
|
* Creates a #View3DCameraControl handle and sets up
|
||||||
* the view for first-person style navigation.
|
* the view for first-person style navigation.
|
||||||
*/
|
*/
|
||||||
struct View3DCameraControl *ED_view3d_cameracontrol_acquire(
|
struct View3DCameraControl *ED_view3d_cameracontrol_acquire(
|
||||||
|
|
|
@ -6313,7 +6313,7 @@ static bool createEdgeSlideVerts_double_side(TransInfo *t)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A simple version of #createEdgeSlideVerts
|
* A simple version of #createEdgeSlideVerts_double_side
|
||||||
* Which assumes the longest unselected.
|
* Which assumes the longest unselected.
|
||||||
*/
|
*/
|
||||||
static bool createEdgeSlideVerts_single_side(TransInfo *t)
|
static bool createEdgeSlideVerts_single_side(TransInfo *t)
|
||||||
|
|
|
@ -64,7 +64,7 @@
|
||||||
*
|
*
|
||||||
* Create a structDNA: only needed when one of the input include (.h) files change.
|
* Create a structDNA: only needed when one of the input include (.h) files change.
|
||||||
* File Syntax:
|
* File Syntax:
|
||||||
* <pre>
|
* \code{.unparsed}
|
||||||
* SDNA (4 bytes) (magic number)
|
* SDNA (4 bytes) (magic number)
|
||||||
* NAME (4 bytes)
|
* NAME (4 bytes)
|
||||||
* <nr> (4 bytes) amount of names (int)
|
* <nr> (4 bytes) amount of names (int)
|
||||||
|
@ -86,7 +86,7 @@
|
||||||
* STRC (4 bytes)
|
* STRC (4 bytes)
|
||||||
* <nr> amount of structs (int)
|
* <nr> amount of structs (int)
|
||||||
* <typenr><nr_of_elems> <typenr><namenr> <typenr><namenr> ...
|
* <typenr><nr_of_elems> <typenr><namenr> <typenr><namenr> ...
|
||||||
*</pre>
|
* \endcode
|
||||||
*
|
*
|
||||||
* **Remember to read/write integer and short aligned!**
|
* **Remember to read/write integer and short aligned!**
|
||||||
*
|
*
|
||||||
|
|
|
@ -435,9 +435,7 @@
|
||||||
|
|
||||||
|
|
||||||
/* -------------------------------------------------------------------- */
|
/* -------------------------------------------------------------------- */
|
||||||
|
/* Forward Declarations */
|
||||||
/** \name Forward Declarations
|
|
||||||
* \{ */
|
|
||||||
|
|
||||||
static PyObject *Buffer_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
|
static PyObject *Buffer_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
|
||||||
static PyObject *Method_ShaderSource(PyObject *self, PyObject *args);
|
static PyObject *Method_ShaderSource(PyObject *self, PyObject *args);
|
||||||
|
@ -452,8 +450,6 @@ static int Buffer_ass_slice(Buffer *self, int begin, int end, PyObject *seq);
|
||||||
static PyObject *Buffer_subscript(Buffer *self, PyObject *item);
|
static PyObject *Buffer_subscript(Buffer *self, PyObject *item);
|
||||||
static int Buffer_ass_subscript(Buffer *self, PyObject *item, PyObject *value);
|
static int Buffer_ass_subscript(Buffer *self, PyObject *item, PyObject *value);
|
||||||
|
|
||||||
/** \} */
|
|
||||||
|
|
||||||
|
|
||||||
/* -------------------------------------------------------------------- */
|
/* -------------------------------------------------------------------- */
|
||||||
|
|
||||||
|
@ -756,7 +752,7 @@ static PyObject *Buffer_new(PyTypeObject *UNUSED(type), PyObject *args, PyObject
|
||||||
return (PyObject *)buffer;
|
return (PyObject *)buffer;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*@ Buffer sequence methods */
|
/* Buffer sequence methods */
|
||||||
|
|
||||||
static int Buffer_len(Buffer *self)
|
static int Buffer_len(Buffer *self)
|
||||||
{
|
{
|
||||||
|
|
|
@ -56,8 +56,7 @@ void threaded_makeshadowbufs(struct Render *re);
|
||||||
float testshadowbuf(struct Render *re, struct ShadBuf *shb, const float rco[3], const float dxco[3], const float dyco[3], float inp, float mat_bias);
|
float testshadowbuf(struct Render *re, struct ShadBuf *shb, const float rco[3], const float dxco[3], const float dyco[3], float inp, float mat_bias);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Determines the shadow factor for lamp <lar>, between <p1>
|
* Determines the shadow factor for lamp \a lar, between \a p1 and \a p2. (Which CS?)
|
||||||
* and <p2>. (Which CS?)
|
|
||||||
*/
|
*/
|
||||||
float shadow_halo(LampRen *lar, const float p1[3], const float p2[3]);
|
float shadow_halo(LampRen *lar, const float p1[3], const float p2[3]);
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue