From: Ben Schmidt <none@none>
Date: Fri, 20 Apr 2012 00:35:27 +0000 (+1000)
Subject: Add comment to clarify purpose and interface of handle_conditional().
X-Git-Tag: RELEASE_1_2_18rc1~3
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6c4e672f560137ccec3e4e4910b7f3f6f4cfa646;p=thirdparty%2Fmlmmj.git

Add comment to clarify purpose and interface of handle_conditional().
---

diff --git a/src/prepstdreply.c b/src/prepstdreply.c
index 747a5925..bd47c5b8 100644
--- a/src/prepstdreply.c
+++ b/src/prepstdreply.c
@@ -722,6 +722,13 @@ static int handle_conditional(text *txt, char **line_p, char **pos_p,
 		int neg, enum conditional_target tgt, int multi,
 		const char *listdir)
 {
+	/* This function handles a conditional directive and returns a boolean
+	 * (0 or 1) representing whether it was successfully handled or not.
+	 * The conditional should already have been identified, and the type of
+	 * conditional, whether it is negative, whether multiple parameters are
+	 * acceptable, and the position of the first parameter should be passed
+	 * in.
+	*/
 	char *line = *line_p;
 	char *pos;
 	int satisfied = 0;