From: Arran Cudbard-Bell <a.cudbardb@freeradius.org>
Date: Wed, 9 Nov 2011 13:01:14 +0000 (+0100)
Subject: Fixup doxygen comments in exec.c
X-Git-Tag: release_3_0_0_beta0~515
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1a28ef73b03376e3491c9ea5a1b9f8136a82ccf6;p=thirdparty%2Ffreeradius-server.git

Fixup doxygen comments in exec.c
---

diff --git a/src/main/exec.c b/src/main/exec.c
index 7e20e8669d7..82106c60787 100644
--- a/src/main/exec.c
+++ b/src/main/exec.c
@@ -66,20 +66,20 @@ static void tv_sub(struct timeval *end, struct timeval *start,
 }
 
 
-/**
- * @brief Start a process
+/** Start a process
  *
  * @param cmd Command to execute. This is parsed into argv[] parts,
- * 	then each individual argv part is xlat'ed
+ * 	then each individual argv part is xlat'ed.
  * @param request Current reuqest
  * @param exec_wait set to 1 if you want to read from or write to child
- * @param[in,out] input_fd pointer to int, receives the stdin file
+ * @param[in,out] input_fd pointer to int, receives the stdin file.
  * 	descriptor. Set to NULL and the child will have /dev/null on stdin
  * @param[in,out] output_fd pinter to int, receives the stdout file
- * 	descriptor. Set to NULL and child will have /dev/null on stdout
+ * 	descriptor. Set to NULL and child will have /dev/null on stdout.
  * @param input_pairs list of value pairs - these will be put into
- * 	the environment variables of the child
- * @return PID of the child process, -1 on error
+ * 	the environment variables of the child.
+ * @param shell_escape
+ * @return PID of the child process, -1 on error.
  */
 pid_t radius_start_program(const char *cmd, REQUEST *request,
 			int exec_wait,
@@ -425,15 +425,14 @@ pid_t radius_start_program(const char *cmd, REQUEST *request,
 	return pid;
 }
 
-/**
- * @brief read from the child process
+/** Read from the child process.
  *
- * @param fd file descriptor to read from
- * @param pid pid of child, will be reaped if it dies
- * @param timeout amount of time to wait, in seconds
- * @param answer buffer to write into
- * @param left length of buffer
- * @return -1 on error, or length of output
+ * @param fd file descriptor to read from.
+ * @param pid pid of child, will be reaped if it dies.
+ * @param timeout amount of time to wait, in seconds.
+ * @param answer buffer to write into.
+ * @param left length of buffer.
+ * @return -1 on error, or length of output.
  */
 int radius_readfrom_program(int fd, pid_t pid, int timeout, char *answer, int left) {
 
@@ -553,20 +552,20 @@ int radius_readfrom_program(int fd, pid_t pid, int timeout, char *answer, int le
 	return done;
 }
 
-/**
- * @brief Execute a program
+/** Execute a program.
  *
  * @param cmd Command to execute. This is parsed into argv[] parts,
- * 	then each individual argv part is xlat'ed
- * @param request Current reuqest
+ * 	then each individual argv part is xlat'ed.
+ * @param request current request.
  * @param exec_wait set to 1 if you want to read from or write to child
- * @param user_msg buffer to append plaintext (non valuepair) output
- * @param user_msg_len length of user_msg buffer
+ * @param user_msg buffer to append plaintext (non valuepair) output.
+ * @param msg_len length of user_msg buffer.
  * @param input_pairs list of value pairs - these will be put into
- * 	the environment variables of the child
+ * 	the environment variables of the child.
  * @param[out] output_pairs list of value pairs - child stdout will be
- * 	parsed and added into this list of value pairs
- * @return 0 if exec_wait==0, exit code if exec_wait!=0, -1 on error
+ * 	parsed and added into this list of value pairs.
+ * @param shell_escape
+ * @return 0 if exec_wait==0, exit code if exec_wait!=0, -1 on error.
  */
 int radius_exec_program(const char *cmd, REQUEST *request,
 			int exec_wait,