about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2010-12-27 17:37:56 +0100
committerAlexander Barton <alex@barton.de>2011-02-13 17:52:39 +0100
commit5858dc3886e492f96a42b61decdda3c1acd920a4 (patch)
treef9ae253d3c85be39521d4bd8fe354d6260a17443 /src
parentaf6ac0fa41a10889cdaf9898d995980bebcefec1 (diff)
downloadngircd-5858dc3886e492f96a42b61decdda3c1acd920a4.tar.gz
ngircd-5858dc3886e492f96a42b61decdda3c1acd920a4.zip
Doxygen'ify proc.h
Diffstat (limited to 'src')
-rw-r--r--src/ngircd/proc.h7
1 files changed, 5 insertions, 2 deletions
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));