]> arthur.barton.de Git - ngircd-alex.git/commitdiff
Doxygen'ify proc.h
authorAlexander Barton <alex@barton.de>
Mon, 27 Dec 2010 16:37:56 +0000 (17:37 +0100)
committerAlexander Barton <alex@barton.de>
Sun, 13 Feb 2011 16:52:39 +0000 (17:52 +0100)
src/ngircd/proc.h

index bb4bceb2083c6cb55e4c754c752b225c821d9b48..84b61f2bf2ae2c26db2a4ef641e17711b8266aa6 100644 (file)
 
 /** 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));