From: Alexander Barton <alex@barton.de>
Date: Mon, 27 Dec 2010 16:37:56 +0000 (+0100)
Subject: Doxygen'ify proc.h
X-Git-Tag: rel-18-rc1~54
X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git;a=commitdiff_plain;h=5858dc3886e492f96a42b61decdda3c1acd920a4

Doxygen'ify proc.h
---

diff --git a/src/ngircd/proc.h b/src/ngircd/proc.h
index bb4bceb2..84b61f2b 100644
--- a/src/ngircd/proc.h
+++ b/src/ngircd/proc.h
@@ -19,11 +19,14 @@
 
 /** Process status. This struct must not be accessed directly! */
 typedef struct _Proc_Stat {
-	pid_t pid;	/* PID of the child process or 0 if none */
-	int pipe_fd;	/* Pipe file descriptor or -1 if none */
+	pid_t pid;	/**< PID of the child process or 0 if none */
+	int pipe_fd;	/**< Pipe file descriptor or -1 if none */
 } PROC_STAT;
 
+/** Return true if sub-process is still running */
 #define Proc_InProgress(x)	((x)->pid != 0)
+
+/** Return file descriptor of pipe to sub-process (or -1 if none open) */
 #define Proc_GetPipeFd(x)	((x)->pipe_fd)
 
 GLOBAL void Proc_InitStruct PARAMS((PROC_STAT *proc));