Add a comment to prevent mind blowing

drwtsnthirty2 · Feb 19, 2019 · d9fc6b6 · d9fc6b6
1 parent bc6947e
commit d9fc6b6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/XCCDF_POLICY/xccdf_policy_remediate.c b/src/XCCDF_POLICY/xccdf_policy_remediate.c
@@ -802,6 +802,10 @@ static int _xccdf_item_recursive_gather_selected_rules(struct xccdf_policy *poli
 	return ret;
 }
 
+/* Handles multiline strings in profile title and description.
+ * Puts a '#' at the beginning of each line.
+ * Also removes trailing and leading whitespaces on each line.
+ */
 static char *_comment_multiline_text(char *text)
 {
 	if (text == NULL) {