summaryrefslogtreecommitdiff
path: root/prism/util/pm_string_list.c
diff options
context:
space:
mode:
authorKevin Newton <[email protected]>2023-10-30 23:09:18 -0400
committerKevin Newton <[email protected]>2023-11-01 13:10:29 -0400
commitb67994d6bf88fcfd66fc0368a03a92aa81fe8b11 (patch)
tree7be44eaaeff6053bfe4d21b5a3973e8153ff6d15 /prism/util/pm_string_list.c
parent7c8d93968009d1f3123ebc78906d4abb896e6905 (diff)
[ruby/prism] Even more C documentation
https://github.com/ruby/prism/commit/bec5ca37a0
Diffstat (limited to 'prism/util/pm_string_list.c')
-rw-r--r--prism/util/pm_string_list.c14
1 files changed, 10 insertions, 4 deletions
diff --git a/prism/util/pm_string_list.c b/prism/util/pm_string_list.c
index 87e63a43eb..fa7f20619f 100644
--- a/prism/util/pm_string_list.c
+++ b/prism/util/pm_string_list.c
@@ -1,14 +1,18 @@
#include "prism/util/pm_string_list.h"
-// Initialize a pm_string_list_t with its default values.
+/**
+ * Initialize a pm_string_list_t with its default values.
+ */
void
pm_string_list_init(pm_string_list_t *string_list) {
- string_list->strings = (pm_string_t *) malloc(sizeof(pm_string_t));
string_list->length = 0;
string_list->capacity = 1;
+ string_list->strings = (pm_string_t *) malloc(sizeof(pm_string_t));
}
-// Append a pm_string_t to the given string list.
+/**
+ * Append a pm_string_t to the given string list.
+ */
void
pm_string_list_append(pm_string_list_t *string_list, pm_string_t *string) {
if (string_list->length + 1 > string_list->capacity) {
@@ -22,7 +26,9 @@ pm_string_list_append(pm_string_list_t *string_list, pm_string_t *string) {
string_list->strings[string_list->length++] = *string;
}
-// Free the memory associated with the string list.
+/**
+ * Free the memory associated with the string list
+ */
void
pm_string_list_free(pm_string_list_t *string_list) {
free(string_list->strings);