X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fngircd%2Fproc.h;h=4a80edfcce70b3cb261827c28f3290384f337bee;hb=f8f7f83f5a2228bb9deeb8324be015cd76b84ced;hp=57612f172d5e61e2339ea703758a0283b5b9be7c;hpb=6ebb31ab35e7f9258f4df9d0bfd111dc75677bfe;p=ngircd-alex.git

diff --git a/src/ngircd/proc.h b/src/ngircd/proc.h
index 57612f17..4a80edfc 100644
--- a/src/ngircd/proc.h
+++ b/src/ngircd/proc.h
@@ -1,26 +1,32 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2010 Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2011 Alexander Barton (alex@barton.de) and Contributors.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * 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));
@@ -32,6 +38,9 @@ GLOBAL void Proc_GenericSignalHandler PARAMS((int Signal));
 
 GLOBAL size_t Proc_Read PARAMS((PROC_STAT *proc, void *buffer, size_t buflen));
 
+GLOBAL void Proc_Close PARAMS((PROC_STAT *proc));
+
+
 #endif
 
 /* -eof- */