Added documentation (best effort) to SCDArray functions.

include/scufcont/DArray.h

@@ -31,10 +31,6 @@
     SCDARRAY_EXPANDER(SCDARRAY_CLEAR_NO_RESIZE, type, type_name, clear_no_resize)       \
     SCDARRAY_EXPANDER(SCDARRAY_CLEAR, type, type_name, clear)
 
-#define SCDARRAY_HEADER(type, type_name) \
-    SCDARRAY_STRUCT(type, type_name)     \
-    SCDARRAY_SIGS(type, type_name)
-
 #define SCDARRAY_SIGS(type, type_name)                                                       \
     SCDARRAY_EXPANDER(SCDARRAY_ALLOC_SIG, type, type_name, alloc);                           \
     SCDARRAY_EXPANDER(SCDARRAY_FREE_SIG, type, type_name, free);                             \
@@ -47,6 +43,10 @@
     SCDARRAY_EXPANDER(SCDARRAY_CLEAR_NO_RESIZE_SIG, type, type_name, clear_no_resize);       \
     SCDARRAY_EXPANDER(SCDARRAY_CLEAR_SIG, type, type_name, clear);
 
+#define SCDARRAY_HEADER(type, type_name) \
+    SCDARRAY_STRUCT(type, type_name)     \
+    SCDARRAY_SIGS(type, type_name)
+
 // SCDARRAY_ALLOC_SIG(type, SCDArray_##type_name, SCDArray_##type_name##_alloc);
 // SCDARRAY_PUSH_BACK_SIG(type, SCDArray_##type_name, SCDArray_##type_name##_push_back);
 
@@ -61,6 +61,12 @@
 
 #define SCDARRAY_ALLOC_SIG(type, type_name, func_name) ScufContResult func_name(type_name *const darr)
 
+/**
+  @fn SCDArray_alloc
+
+  @return SCUFCONT_OUT_OF_MEMORY
+  @return SCUFCONT_SUCCESS
+*/
 #define SCDARRAY_ALLOC(type, type_name, func_name)     \
     SCDARRAY_ALLOC_SIG(type, type_name, func_name) {   \
         darr->data = (type *) calloc(1, sizeof(type)); \
@@ -90,6 +96,12 @@
 
 #define SCDARRAY_PUSH_BACK_SIG(type, type_name, func_name) ScufContResult func_name(type_name *const darr, const type *const new_elem)
 
+/**
+  @fn SCDArray_push_back
+
+  @return SCUFCONT_OUT_OF_MEMORY
+  @return SCUFCONT_SUCCESS
+*/
 #define SCDARRAY_PUSH_BACK(type, type_name, func_name)                                     \
     SCDARRAY_PUSH_BACK_SIG(type, type_name, func_name) {                                   \
         if (darr->len + 1 > darr->capacity) {                                              \
@@ -106,6 +118,12 @@
 
 #define SCDARRAY_PUSH_BACK_MULTIPLE_SIG(type, type_name, func_name) ScufContResult func_name(type_name *const darr, const type *const new_elems, const size_t new_elems_n)
 
+/**
+  @fn SCDArray_push_back_multiple
+
+  @return SCUFCONT_OUT_OF_MEMORY
+  @return SCUFCONT_SUCCESS
+*/
 #define SCDARRAY_PUSH_BACK_MULTIPLE(type, type_name, func_name)                                       \
     SCDARRAY_PUSH_BACK_MULTIPLE_SIG(type, type_name, func_name) {                                     \
         if (darr->len + new_elems_n > darr->capacity) {                                               \

src/DString.c

@@ -122,10 +122,6 @@ bool SCDString_equal_next_chars_c_str(
     return true;
 }
 
-/**
-  @return SCUFCONT_OUT_OF_MEMORY
-  @return SCUFCONT_SUCCESS
-*/
 ScufContResult SCDString_concat_char(SCDString *const dstr, const char ch) {
     const size_t new_len = dstr->len + 1;
     if (new_len > dstr->capacity) {
@@ -142,10 +138,6 @@ ScufContResult SCDString_concat_char(SCDString *const dstr, const char ch) {
     return SCUFCONT_SUCCESS;
 }
 
-/**
-  @return SCUFCONT_OUT_OF_MEMORY
-  @return SCUFCONT_SUCCESS
-*/
 ScufContResult SCDString_concat_c_str(
     SCDString *const dstr,
     const char *str,
@@ -166,10 +158,6 @@ ScufContResult SCDString_concat_c_str(
     return SCUFCONT_SUCCESS;
 }
 
-/**
-  @return SCUFCONT_OUT_OF_MEMORY
-  @return SCUFCONT_SUCCESS
-*/
 ScufContResult SCDString_alloc_concat_c_strs(
     SCDString *const dstr,
     const char *s1,
@@ -188,10 +176,6 @@ ScufContResult SCDString_alloc_concat_c_strs(
     return SCUFCONT_SUCCESS;
 }
 
-/**
-  @return SCUFCONT_OUT_OF_MEMORY
-  @return SCUFCONT_SUCCESS
-*/
 ScufContResult SCDString_split(
     const SCDString *const dstr,
     const char *delim,
@@ -254,10 +238,6 @@ void SCDString_split_arr_free(SCDString **const arr, const size_t arr_len) {
     *arr = NULL;
 }
 
-/**
-  @return SCUFCONT_OUT_OF_BOUNDS
-  @return SCUFCONT_SUCCESS
-*/
 ScufContResult SCDString_char_mod(SCDString *const dstr, const size_t at, const char ch) {
     if (at > dstr->len - 1) {
         return SCUFCONT_OUT_OF_BOUNDS;
@@ -268,10 +248,6 @@ ScufContResult SCDString_char_mod(SCDString *const dstr, const size_t at, const
     return SCUFCONT_SUCCESS;
 }
 
-/**
-  @return SCUFCONT_OUT_OF_BOUNDS
-  @return SCUFCONT_SUCCESS
-*/
 ScufContResult SCDString_char_remove_no_resize(SCDString *const dstr, const size_t at) {
     if (at > dstr->len - 1) {
         return SCUFCONT_OUT_OF_BOUNDS;
@@ -282,10 +258,6 @@ ScufContResult SCDString_char_remove_no_resize(SCDString *const dstr, const size
     return SCUFCONT_SUCCESS;
 }
 
-/**
-  @return SCUFCONT_OUT_OF_BOUNDS
-  @return SCUFCONT_SUCCESS
-*/
 ScufContResult SCDString_char_remove(SCDString *const dstr, const size_t at) {
     const ScufContResult res = SCDString_char_remove_no_resize(dstr, at);
     if (res != SCUFCONT_SUCCESS) {
@@ -297,11 +269,6 @@ ScufContResult SCDString_char_remove(SCDString *const dstr, const size_t at) {
     return SCUFCONT_SUCCESS;
 }
 
-/**
-  @return SCUFCONT_OUT_OF_BOUNDS
-  @return SCUFCONT_OUT_OF_MEMORY
-  @return SCUFCONT_SUCCESS
-*/
 ScufContResult SCDString_char_insert(SCDString *const dstr, const size_t at, const char ch) {
     if (at > dstr->len) {
         return SCUFCONT_OUT_OF_BOUNDS;