Cleanup: use doxy sections

This commit is contained in:
Campbell Barton 2020-04-07 22:20:41 +10:00
parent 3a65397473
commit 1de5cb6a31
2 changed files with 49 additions and 6 deletions

View File

@ -1883,7 +1883,9 @@ bool BKE_object_obdata_is_libdata(const Object *ob)
return (ob && ob->data && ID_IS_LINKED(ob->data));
}
/* *************** PROXY **************** */
/* -------------------------------------------------------------------- */
/** \name Object Proxy API
* \{ */
/* when you make proxy, ensure the exposed layers are extern */
static void armature_set_id_extern(Object *ob)
@ -2093,7 +2095,11 @@ void BKE_object_obdata_size_init(struct Object *ob, const float size)
}
}
/* *************** CALC ****************** */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Object Matrix Get/Set API
* \{ */
void BKE_object_scale_to_mat3(Object *ob, float mat[3][3])
{
@ -2586,6 +2592,12 @@ void BKE_object_get_parent_matrix(Object *ob, Object *par, float parentmat[4][4]
}
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Object Matrix Evaluation API
* \{ */
/**
* \param r_originmat: Optional matrix that stores the space the object is in
* (without its own matrix applied)
@ -2790,6 +2802,12 @@ void BKE_object_apply_mat4(Object *ob,
BKE_object_apply_mat4_ex(ob, mat, use_parent ? ob->parent : NULL, ob->parentinv, use_compat);
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Object Bounding Box API
* \{ */
BoundBox *BKE_boundbox_alloc_unit(void)
{
BoundBox *bb;
@ -2911,6 +2929,8 @@ void BKE_object_boundbox_calc_from_mesh(struct Object *ob, struct Mesh *me_eval)
ob->runtime.bb->flag &= ~BOUNDBOX_DIRTY;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Object Dimension Get/Set
*
@ -3594,9 +3614,11 @@ void BKE_object_delete_ptcache(Object *ob, int index)
BLI_freelinkN(&ob->pc_ids, link);
}
/* shape key utility function */
/* -------------------------------------------------------------------- */
/** \name Object Data Shape Key Insert
* \{ */
/************************* Mesh ************************/
/* Mesh */
static KeyBlock *insert_meshkey(Main *bmain, Object *ob, const char *name, const bool from_mix)
{
Mesh *me = ob->data;
@ -3628,7 +3650,7 @@ static KeyBlock *insert_meshkey(Main *bmain, Object *ob, const char *name, const
return kb;
}
/************************* Lattice ************************/
/* Lattice */
static KeyBlock *insert_lattkey(Main *bmain, Object *ob, const char *name, const bool from_mix)
{
Lattice *lt = ob->data;
@ -3666,7 +3688,7 @@ static KeyBlock *insert_lattkey(Main *bmain, Object *ob, const char *name, const
return kb;
}
/************************* Curve ************************/
/* Curve */
static KeyBlock *insert_curvekey(Main *bmain, Object *ob, const char *name, const bool from_mix)
{
Curve *cu = ob->data;
@ -3707,6 +3729,12 @@ static KeyBlock *insert_curvekey(Main *bmain, Object *ob, const char *name, cons
return kb;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Object Shape Key API
* \{ */
KeyBlock *BKE_object_shapekey_insert(Main *bmain,
Object *ob,
const char *name,
@ -3804,6 +3832,8 @@ bool BKE_object_shapekey_remove(Main *bmain, Object *ob, KeyBlock *kb)
return true;
}
/** \} */
bool BKE_object_flag_test_recursive(const Object *ob, short flag)
{
if (ob->flag & flag) {

View File

@ -37,6 +37,10 @@
#include "GPU_batch_utils.h"
#include "gpu_shader_private.h"
/* -------------------------------------------------------------------- */
/** \name Local Structures
* \{ */
/* Struct to store 3D Batches and their format */
static struct {
struct {
@ -75,6 +79,8 @@ static struct {
static ListBase presets_list = {NULL, NULL};
/** \} */
/* -------------------------------------------------------------------- */
/** \name 3D Primitives
* \{ */
@ -228,6 +234,7 @@ static GPUBatch *batch_sphere_wire(int lat_res, int lon_res)
/* -------------------------------------------------------------------- */
/** \name Panel Drag Widget
* \{ */
static void gpu_batch_preset_rectf_tris_color_ex(GPUVertBufRaw *pos_step,
float x1,
float y1,
@ -328,6 +335,10 @@ GPUBatch *GPU_batch_preset_panel_drag_widget(const float pixelsize,
/** \} */
/* -------------------------------------------------------------------- */
/** \name Preset Registration Management
* \{ */
void gpu_batch_presets_init(void)
{
BLI_mutex_init(&g_presets_3d.mutex);
@ -394,3 +405,5 @@ void gpu_batch_presets_exit(void)
BLI_mutex_end(&g_presets_3d.mutex);
}
/** \} */