forked from bartvdbraak/blender
Cleanup: doxy comments
This commit is contained in:
parent
d06384aa41
commit
9b02415ec8
@ -56,8 +56,8 @@ bool MEM_CacheLimiter_is_disabled(void);
|
|||||||
* Create new MEM_CacheLimiter object
|
* Create new MEM_CacheLimiter object
|
||||||
* managed objects are destructed with the data_destructor
|
* managed objects are destructed with the data_destructor
|
||||||
*
|
*
|
||||||
* \param data_destructor
|
* \param data_destructor: TODO.
|
||||||
* \return A new MEM_CacheLimter object
|
* \return A new #MEM_CacheLimter object.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_destructor,
|
MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_destructor,
|
||||||
@ -68,7 +68,7 @@ MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_dest
|
|||||||
*
|
*
|
||||||
* Frees the memory of the CacheLimiter but does not touch managed objects!
|
* Frees the memory of the CacheLimiter but does not touch managed objects!
|
||||||
*
|
*
|
||||||
* \param This "This" pointer
|
* \param This: "This" pointer.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
|
void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
|
||||||
@ -76,7 +76,7 @@ void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
|
|||||||
/**
|
/**
|
||||||
* Manage object
|
* Manage object
|
||||||
*
|
*
|
||||||
* \param This "This" pointer, data data object to manage
|
* \param This: "This" pointer, data data object to manage.
|
||||||
* \return CacheLimiterHandle to ref, unref, touch the managed object
|
* \return CacheLimiterHandle to ref, unref, touch the managed object
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@ -85,7 +85,7 @@ MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC *This, void *
|
|||||||
/**
|
/**
|
||||||
* Free objects until memory constraints are satisfied
|
* Free objects until memory constraints are satisfied
|
||||||
*
|
*
|
||||||
* \param This "This" pointer
|
* \param This: "This" pointer.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
|
void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
|
||||||
@ -94,7 +94,7 @@ void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
|
|||||||
* Unmanage object previously inserted object.
|
* Unmanage object previously inserted object.
|
||||||
* Does _not_ delete managed object!
|
* Does _not_ delete managed object!
|
||||||
*
|
*
|
||||||
* \param handle of object
|
* \param handle: of object.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
|
void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
|
||||||
@ -102,7 +102,7 @@ void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
|
|||||||
/**
|
/**
|
||||||
* Raise priority of object (put it at the tail of the deletion chain)
|
* Raise priority of object (put it at the tail of the deletion chain)
|
||||||
*
|
*
|
||||||
* \param handle of object
|
* \param handle: of object.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
|
void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
|
||||||
@ -111,7 +111,7 @@ void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
|
|||||||
* Increment reference counter. Objects with reference counter != 0 are _not_
|
* Increment reference counter. Objects with reference counter != 0 are _not_
|
||||||
* deleted.
|
* deleted.
|
||||||
*
|
*
|
||||||
* \param handle of object
|
* \param handle: of object.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
|
void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
|
||||||
@ -120,7 +120,7 @@ void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
|
|||||||
* Decrement reference counter. Objects with reference counter != 0 are _not_
|
* Decrement reference counter. Objects with reference counter != 0 are _not_
|
||||||
* deleted.
|
* deleted.
|
||||||
*
|
*
|
||||||
* \param handle of object
|
* \param handle: of object.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
|
void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
|
||||||
@ -128,7 +128,7 @@ void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
|
|||||||
/**
|
/**
|
||||||
* Get reference counter.
|
* Get reference counter.
|
||||||
*
|
*
|
||||||
* \param handle of object
|
* \param handle: of object.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
|
int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
|
||||||
@ -136,7 +136,7 @@ int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
|
|||||||
/**
|
/**
|
||||||
* Get pointer to managed object
|
* Get pointer to managed object
|
||||||
*
|
*
|
||||||
* \param handle of object
|
* \param handle: of object.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
|
void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
|
||||||
|
@ -218,8 +218,8 @@ void RB_dworld_step_simulation(rbDynamicsWorld *world,
|
|||||||
* Exports entire dynamics world to Bullet's "*.bullet" binary format
|
* Exports entire dynamics world to Bullet's "*.bullet" binary format
|
||||||
* which is similar to Blender's SDNA system.
|
* which is similar to Blender's SDNA system.
|
||||||
*
|
*
|
||||||
* \param world Dynamics world to write to file
|
* \param world: Dynamics world to write to file
|
||||||
* \param filename Assumed to be a valid filename, with .bullet extension
|
* \param filename: Assumed to be a valid filename, with .bullet extension
|
||||||
*/
|
*/
|
||||||
void RB_dworld_export(rbDynamicsWorld *world, const char *filename)
|
void RB_dworld_export(rbDynamicsWorld *world, const char *filename)
|
||||||
{
|
{
|
||||||
|
@ -195,10 +195,10 @@ bool DEG_debug_consistency_check(Depsgraph *graph)
|
|||||||
/* ------------------------------------------------ */
|
/* ------------------------------------------------ */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Obtain simple statistics about the complexity of the depsgraph
|
* Obtain simple statistics about the complexity of the depsgraph.
|
||||||
* \param[out] r_outer The number of outer nodes in the graph
|
* \param[out] r_outer: The number of outer nodes in the graph
|
||||||
* \param[out] r_operations The number of operation nodes in the graph
|
* \param[out] r_operations: The number of operation nodes in the graph
|
||||||
* \param[out] r_relations The number of relations between (executable) nodes in the graph
|
* \param[out] r_relations: The number of relations between (executable) nodes in the graph
|
||||||
*/
|
*/
|
||||||
void DEG_stats_simple(const Depsgraph *graph,
|
void DEG_stats_simple(const Depsgraph *graph,
|
||||||
size_t *r_outer,
|
size_t *r_outer,
|
||||||
|
@ -708,8 +708,8 @@ void gp_apply_parent_point(Depsgraph *depsgraph, Object *obact, bGPDlayer *gpl,
|
|||||||
/**
|
/**
|
||||||
* Convert a Grease Pencil coordinate (i.e. can be 2D or 3D) to screenspace (2D)
|
* Convert a Grease Pencil coordinate (i.e. can be 2D or 3D) to screenspace (2D)
|
||||||
*
|
*
|
||||||
* \param[out] r_x The screen-space x-coordinate of the point
|
* \param[out] r_x: The screen-space x-coordinate of the point
|
||||||
* \param[out] r_y The screen-space y-coordinate of the point
|
* \param[out] r_y: The screen-space y-coordinate of the point
|
||||||
*
|
*
|
||||||
* \warning This assumes that the caller has already checked
|
* \warning This assumes that the caller has already checked
|
||||||
* whether the stroke in question can be drawn.
|
* whether the stroke in question can be drawn.
|
||||||
|
@ -313,8 +313,8 @@ void ACTION_OT_previewrange_set(wmOperatorType *ot)
|
|||||||
/**
|
/**
|
||||||
* Find the extents of the active channel
|
* Find the extents of the active channel
|
||||||
*
|
*
|
||||||
* \param[out] min Bottom y-extent of channel
|
* \param[out] min: Bottom y-extent of channel
|
||||||
* \param[out] max Top y-extent of channel
|
* \param[out] max: Top y-extent of channel
|
||||||
* \return Success of finding a selected channel
|
* \return Success of finding a selected channel
|
||||||
*/
|
*/
|
||||||
static bool actkeys_channels_get_selected_extents(bAnimContext *ac, float *min, float *max)
|
static bool actkeys_channels_get_selected_extents(bAnimContext *ac, float *min, float *max)
|
||||||
|
@ -410,8 +410,8 @@ void NLA_OT_previewrange_set(wmOperatorType *ot)
|
|||||||
/**
|
/**
|
||||||
* Find the extents of the active channel
|
* Find the extents of the active channel
|
||||||
*
|
*
|
||||||
* \param[out] min Bottom y-extent of channel
|
* \param[out] min: Bottom y-extent of channel.
|
||||||
* \param[out] max Top y-extent of channel
|
* \param[out] max: Top y-extent of channel.
|
||||||
* \return Success of finding a selected channel
|
* \return Success of finding a selected channel
|
||||||
*/
|
*/
|
||||||
static bool nla_channels_get_selected_extents(bAnimContext *ac, float *min, float *max)
|
static bool nla_channels_get_selected_extents(bAnimContext *ac, float *min, float *max)
|
||||||
|
@ -105,16 +105,16 @@ static real angle_from_cotan(WVertex *vo, WVertex *v1, WVertex *v2)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*! gts_vertex_mean_curvature_normal:
|
/*! gts_vertex_mean_curvature_normal:
|
||||||
* @v: a #WVertex.
|
* \param v: a #WVertex.
|
||||||
* @s: a #GtsSurface.
|
* \param s: a #GtsSurface.
|
||||||
* @Kh: the Mean Curvature Normal at @v.
|
* \param Kh: the Mean Curvature Normal at \a v.
|
||||||
*
|
*
|
||||||
* Computes the Discrete Mean Curvature Normal approximation at @v.
|
* Computes the Discrete Mean Curvature Normal approximation at \a v.
|
||||||
* The mean curvature at @v is half the magnitude of the vector @Kh.
|
* The mean curvature at \a v is half the magnitude of the vector \a Kh.
|
||||||
*
|
*
|
||||||
* Note: the normal computed is not unit length, and may point either into or out of the surface,
|
* Note: the normal computed is not unit length, and may point either into or out of the surface,
|
||||||
* depending on the curvature at @v. It is the responsibility of the caller of the function to use
|
* depending on the curvature at \a v. It is the responsibility of the caller of the function to
|
||||||
* the mean curvature normal appropriately.
|
* use the mean curvature normal appropriately.
|
||||||
*
|
*
|
||||||
* This approximation is from the paper:
|
* This approximation is from the paper:
|
||||||
* Discrete Differential-Geometry Operators for Triangulated 2-Manifolds
|
* Discrete Differential-Geometry Operators for Triangulated 2-Manifolds
|
||||||
@ -176,11 +176,11 @@ bool gts_vertex_mean_curvature_normal(WVertex *v, Vec3r &Kh)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*! gts_vertex_gaussian_curvature:
|
/*! gts_vertex_gaussian_curvature:
|
||||||
* @v: a #WVertex.
|
* \param v: a #WVertex.
|
||||||
* @s: a #GtsSurface.
|
* \param s: a #GtsSurface.
|
||||||
* @Kg: the Discrete Gaussian Curvature approximation at @v.
|
* \param Kg: the Discrete Gaussian Curvature approximation at \a v.
|
||||||
*
|
*
|
||||||
* Computes the Discrete Gaussian Curvature approximation at @v.
|
* Computes the Discrete Gaussian Curvature approximation at \a v.
|
||||||
*
|
*
|
||||||
* This approximation is from the paper:
|
* This approximation is from the paper:
|
||||||
* Discrete Differential-Geometry Operators for Triangulated 2-Manifolds
|
* Discrete Differential-Geometry Operators for Triangulated 2-Manifolds
|
||||||
@ -280,16 +280,16 @@ static void eigenvector(real a, real b, real c, Vec3r e)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*! gts_vertex_principal_directions:
|
/*! gts_vertex_principal_directions:
|
||||||
* @v: a #WVertex.
|
* \param v: a #WVertex.
|
||||||
* @s: a #GtsSurface.
|
* \param s: a #GtsSurface.
|
||||||
* @Kh: mean curvature normal (a #Vec3r).
|
* \param Kh: mean curvature normal (a #Vec3r).
|
||||||
* @Kg: Gaussian curvature (a real).
|
* \param Kg: Gaussian curvature (a real).
|
||||||
* @e1: first principal curvature direction (direction of largest curvature).
|
* \param e1: first principal curvature direction (direction of largest curvature).
|
||||||
* @e2: second principal curvature direction.
|
* \param e2: second principal curvature direction.
|
||||||
*
|
*
|
||||||
* Computes the principal curvature directions at a point given @Kh and @Kg, the mean curvature
|
* Computes the principal curvature directions at a point given \a Kh and \a Kg,
|
||||||
* normal and Gaussian curvatures at that point, computed with gts_vertex_mean_curvature_normal()
|
* the mean curvature normal and Gaussian curvatures at that point, computed with
|
||||||
* and gts_vertex_gaussian_curvature(), respectively.
|
* gts_vertex_mean_curvature_normal() and gts_vertex_gaussian_curvature(), respectively.
|
||||||
*
|
*
|
||||||
* Note that this computation is very approximate and tends to be unstable. Smoothing of the
|
* Note that this computation is very approximate and tends to be unstable. Smoothing of the
|
||||||
* surface or the principal directions may be necessary to achieve reasonable results.
|
* surface or the principal directions may be necessary to achieve reasonable results.
|
||||||
|
Loading…
Reference in New Issue
Block a user