Add Doxygen @file documentation to each source and header file

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

diff --git a/src/ngircd/proc.h b/src/ngircd/proc.h
index 57612f172d5e61e2339ea703758a0283b5b9be7c..bb4bceb2083c6cb55e4c754c752b225c821d9b48 100644 (file)
--- a/src/ngircd/proc.h
+++ b/src/ngircd/proc.h
@@ -7,14 +7,17 @@
  * 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 */