updated some documentation

include/arc/std/config.h

@@ -335,7 +335,9 @@ void ARC_Config_UnloadFromFileWithCStr(ARC_Config *config, const char *path);
 */
 
 /**
- * @brief TODO: write this
+ * @brief inits a config type with the standard config settings
+ *
+ * @param config the config to init
 */
 void ARC_Config_InitStd(ARC_Config *config);
 

include/arc/std/entity.h

@@ -15,7 +15,7 @@ extern "C" {
 typedef struct ARC_EntitySystem ARC_EntitySystem;
 
 /**
- * @brief an entity component system type
+ * @brief an entity type (just an id)
 */
 typedef uint32_t ARC_Entity;
 

include/arc/std/errno.h

@@ -23,7 +23,7 @@ extern int32_t arc_errno;
     extern FILE *arc_errno_log_file;
 
     #ifndef ARC_DEBUG_LOG_STREAM_OVERRIDE
-        //this functin will be called on start, handy to set the log file to stdout if it is not overrided
+        //this function will be called on start, handy to set the log file to stdout if it is not overrided
         void __attribute__ ((constructor)) ARC_Errno_SetDefaultStream(void);
     #endif // !ARC_DEBUG_LOG_STREAM_OVERRIDE
 #endif // !ARC_DEBUG

include/arc/std/handler.h

@@ -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_