updated some documentation

CMakeLists.txt

@@ -11,12 +11,13 @@ function(print var)
     message("${var} = ${${var}}")
 endfunction()
 
-#TODO: Might want to remove this
+# ~ DEFAULT TO DEBUG IF TYPE NOT SET ~ #
 if(NOT CMAKE_BUILD_TYPE)
     message("[Archeus] Build Type not set, defaulting to Debug")
     set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Default to Debug" FORCE)
 endif()
 
+# ~ COMPILER OPTIONS ~ #
 add_compile_options(
   "-Wall" "-Werror" "-fexceptions"
   "$<$<CONFIG:DEBUG>:-O0;-g3;-ggdb;-DARC_DEBUG;>"

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

@@ -80,7 +80,7 @@ void ARC_Handler_Clear(ARC_Handler *handler);
 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
 */
@@ -90,4 +90,4 @@ uint32_t ARC_Handler_GetSize(ARC_Handler *handler);
 }
 #endif
 
-#endif //ARC_STD_HANDLER_H_
+#endif // !ARC_STD_HANDLER_H_