conf.c: code cleanup

[ngircd-alex.git] / src / ngircd / proc.h

diff --git a/src/ngircd/proc.h b/src/ngircd/proc.h
index 57612f172d5e61e2339ea703758a0283b5b9be7c..84b61f2bf2ae2c26db2a4ef641e17711b8266aa6 100644 (file)
--- a/src/ngircd/proc.h
+++ b/src/ngircd/proc.h
@@ -7,20 +7,26 @@
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  * Please read the file COPYING, README and AUTHORS for more information.
- *
- * Process management (header)
  */
 
 #ifndef __proc_h__
 #define __proc_h__
 
-/* This struct must not be accessed directly! */
+/**
+ * @file
+ * Process management (header)
+ */
+
+/** 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));