herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated some documentation

Browse source
This commit is contained in:
herbglitch 2025-06-21 18:39:16 -06:00
parent 788147b8f2
commit 5fba766695
5 changed files with 19 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

24
include/arc/std/handler.h
View file

@ -10,14 +10,14 @@ extern "C" {
/**
* @brief a handler type
*/
*/
typedef struct ARC_Handler ARC_Handler;
/**
* @brief a function that will take iterated data
*
* @param data iterated data from ARC_Handler_Iterate
*/
*/
typedef void (* ARC_Handler_DataFn)(void *data);
/**
@ -25,14 +25,14 @@ typedef void (* ARC_Handler_DataFn)(void *data);
*
* @param config ARC_Handler to initialize
* @param destroyDataFn function to clean data in handler, can be null
*/
*/
void ARC_Handler_Create(ARC_Handler **handler, ARC_Vector_DestroyDataFn *destroyDataFn);
/**
* @brief destroyes ARC_Handler type
*
* @param handler ARC_Handler to destory
*/
*/
void ARC_Handler_Destroy(ARC_Handler *handler);
/**
@ -40,7 +40,7 @@ void ARC_Handler_Destroy(ARC_Handler *handler);
*
* @param handler ARC_Handler to add to
* @param data data that is being added
*/
*/
void ARC_Handler_Add(ARC_Handler *handler, void *data);
/**
@ -52,7 +52,7 @@ void ARC_Handler_Add(ARC_Handler *handler, void *data);
*
* @param handler ARC_Handler to remove from
* @param index index of data that is being removed
*/
*/
void ARC_Handler_RemoveIndex(ARC_Handler *handler, uint32_t index);
/**
@ -60,14 +60,14 @@ void ARC_Handler_RemoveIndex(ARC_Handler *handler, uint32_t index);
*
* @param handler ARC_Handler to iterate through
* @param datafn function that will be called on each element of data
*/
*/
void ARC_Handler_Iterate(ARC_Handler *handler, ARC_Handler_DataFn datafn);
/**
* @brief clears all data from handler and puts it in trash vector
*
* @param handler ARC_Handler to clear data from
*/
*/
void ARC_Handler_Clear(ARC_Handler *handler);
/**
@ -76,18 +76,18 @@ void ARC_Handler_Clear(ARC_Handler *handler);
* @note cleanfn's main purpose is to help manage memory
*
* @param handler ARC_Handler to remove trash from
*/
*/
void ARC_Handler_Clean(ARC_Handler *handler);
/**
* @brief gets size of vector
* @brief gets size of elements stored in the handler
*
* @param handler ARC_handler to get size from
*/
*/
uint32_t ARC_Handler_GetSize(ARC_Handler *handler);
#ifdef __cplusplus
}
#endif
#endif //ARC_STD_HANDLER_H_
#endif // !ARC_STD_HANDLER_H_