Cr8-xyz/blender
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: doxy comments

Browse Source
This commit is contained in:
Campbell Barton
2020-05-09 17:29:27 +10:00
parent d06384aa41
commit 9b02415ec8
7 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
intern/memutil/MEM_CacheLimiterC-Api.h
View File

@@ -56,8 +56,8 @@ bool MEM_CacheLimiter_is_disabled(void);
* Create new MEM_CacheLimiter object
* managed objects are destructed with the data_destructor
*
* \param data_destructor
* \return A new MEM_CacheLimter object
* \param data_destructor: TODO.
* \return A new #MEM_CacheLimter object.
*/
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!
*
* \param This "This" pointer
* \param This: "This" pointer.
*/
void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
@@ -76,7 +76,7 @@ void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
/**
* 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
*/
@@ -85,7 +85,7 @@ MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC *This, void *
/**
* Free objects until memory constraints are satisfied
*
* \param This "This" pointer
* \param This: "This" pointer.
*/
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.
* Does _not_ delete managed object!
*
* \param handle of object
* \param handle: of object.
*/
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)
*
* \param handle of object
* \param handle: of object.
*/
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_
* deleted.
*
* \param handle of object
* \param handle: of object.
*/
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_
* deleted.
*
* \param handle of object
* \param handle: of object.
*/
void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
@@ -128,7 +128,7 @@ void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
/**
* Get reference counter.
*
* \param handle of object
* \param handle: of object.
*/
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
*
* \param handle of object
* \param handle: of object.
*/
void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);