changeset 874:80f082f2319a

Add comment to clarify purpose and interface of handle_conditional().
author Ben Schmidt
date Fri, 20 Apr 2012 10:35:27 +1000
parents f6764d59010d
children c5d38273f64c
files src/prepstdreply.c
diffstat 1 files changed, 7 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/prepstdreply.c	Sat Mar 31 10:45:32 2012 +1100
+++ b/src/prepstdreply.c	Fri Apr 20 10:35:27 2012 +1000
@@ -722,6 +722,13 @@
 		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;