engine: eachdo: add docstring to handle_eachdo()

1 files changed, 9 insertions, 0 deletions

diff --git a/src/engine/eachdo.c b/src/engine/eachdo.c
index 9126266..30d81e9 100644
--- a/src/engine/eachdo.c
+++ b/src/engine/eachdo.c
@@ -126,6 +126,15 @@ handle_file_source(eachdo_operands_t *operands,
   list_delete(files);
 }
 
+/*
+ * Handles EACHDO calls. Given a pointer to the buffer, it replaces the EACHDO
+ * call along with its content block and ENDEACHDO call with the fetched
+ * content.
+ *
+ * buffer: Pointer to the buffer that is modified
+ * match: Pointer to the key match
+ * directive: Pointer to the directive struct
+ */
 void
 handle_eachdo(char **buffer, key_match_t *match, directive_t *directive)
 {