[ruby/prism] Documentation for diagnostics and regexp

https://github.com/ruby/prism/commit/16e0579044

1 files changed, 11 insertions, 2 deletions

diff --git a/prism/regexp.h b/prism/regexp.h
index 5745512dee..9eae245d1e 100644
--- a/prism/regexp.h
+++ b/prism/regexp.h
@@ -12,8 +12,17 @@
 #include <stddef.h>
 #include <string.h>
 
-// Parse a regular expression and extract the names of all of the named capture
-// groups.
+/**
+ * Parse a regular expression and extract the names of all of the named capture
+ * groups.
+ *
+ * @param source The source code to parse.
+ * @param size The size of the source code.
+ * @param named_captures The list to add the names of the named capture groups.
+ * @param encoding_changed Whether or not the encoding changed from the default.
+ * @param encoding The encoding of the source code.
+ * @return Whether or not the parsing was successful.
+ */
 PRISM_EXPORTED_FUNCTION bool pm_regexp_named_capture_group_names(const uint8_t *source, size_t size, pm_string_list_t *named_captures, bool encoding_changed, pm_encoding_t *encoding);
 
 #endif