Cleanup: doxygen comments

Also correct some outdated symbol references,
add missing 'name' commands.
This commit is contained in:
Campbell Barton
2019-11-25 01:14:39 +11:00
parent ace5677ef0
commit 249f4423ee
89 changed files with 549 additions and 299 deletions

View File

@@ -37,23 +37,23 @@ extern "C" {
/**
* Returns the reference count of this object.
* @param shared The object to query.
* @return The current reference count.
* \param shared: The object to query.
* \return The current reference count.
*/
extern int MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared);
/**
* Increases the reference count of this object.
* @param shared The object to query.
* @return The new reference count.
* \param shared: The object to query.
* \return The new reference count.
*/
extern int MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared);
/**
* Decreases the reference count of this object.
* If the reference count reaches zero, the object self-destructs.
* @param shared The object to query.
* @return The new reference count.
* \param shared: The object to query.
* \return The new reference count.
*/
extern int MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared);