File-level summary documentation for src/lib/*/*.[ch]

13 files changed, 59 insertions, 6 deletions

diff --git a/src/lib/process/daemon.c b/src/lib/process/daemon.c
index edffb04683..6863d05d7e 100644
--- a/src/lib/process/daemon.c
+++ b/src/lib/process/daemon.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file daemon.c
+ * \brief Run the tor process in the background (unix only)
+ **/
+
 #include "orconfig.h"
 #include "lib/process/daemon.h"
 
diff --git a/src/lib/process/daemon.h b/src/lib/process/daemon.h
index 48a65b22e6..1f26e92221 100644
--- a/src/lib/process/daemon.h
+++ b/src/lib/process/daemon.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file daemon.h
+ * \brief Header for daemon.c
+ **/
+
 #ifndef TOR_DAEMON_H
 #define TOR_DAEMON_H
 
diff --git a/src/lib/process/env.c b/src/lib/process/env.c
index 731f609ac1..244cd4a4eb 100644
--- a/src/lib/process/env.c
+++ b/src/lib/process/env.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file env.c
+ * \brief Inspect and manipulate the environment variables.
+ **/
+
 #include "orconfig.h"
 #include "lib/process/env.h"
 
diff --git a/src/lib/process/env.h b/src/lib/process/env.h
index f22599355d..288b923ace 100644
--- a/src/lib/process/env.h
+++ b/src/lib/process/env.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file env.h
+ * \brief Header for env.c
+ **/
+
 #ifndef TOR_ENV_H
 #define TOR_ENV_H
 
diff --git a/src/lib/process/pidfile.c b/src/lib/process/pidfile.c
index f016f21697..17ff8be600 100644
--- a/src/lib/process/pidfile.c
+++ b/src/lib/process/pidfile.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file pidfile.c
+ * \brief Record this process's PID to disk.
+ **/
+
 #include "orconfig.h"
 #include "lib/process/pidfile.h"
 
diff --git a/src/lib/process/pidfile.h b/src/lib/process/pidfile.h
index c85cd1905e..945edee990 100644
--- a/src/lib/process/pidfile.h
+++ b/src/lib/process/pidfile.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file pidfile.h
+ * \brief Header for pidfile.c
+ **/
+
 #ifndef TOR_PIDFILE_H
 #define TOR_PIDFILE_H
 
diff --git a/src/lib/process/restrict.c b/src/lib/process/restrict.c
index bb44cc3d15..fc1a308806 100644
--- a/src/lib/process/restrict.c
+++ b/src/lib/process/restrict.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file restrict.c
+ * \brief Drop privileges from the current process.
+ **/
+
 #include "orconfig.h"
 #include "lib/process/restrict.h"
 #include "lib/intmath/cmp.h"
diff --git a/src/lib/process/restrict.h b/src/lib/process/restrict.h
index c7f76f8233..2e78dc468c 100644
--- a/src/lib/process/restrict.h
+++ b/src/lib/process/restrict.h
@@ -4,8 +4,8 @@
 /* See LICENSE for licensing information */
 
 /**
- * \file waitpid.h
- * \brief Headers for waitpid.c
+ * \file restrict.h
+ * \brief Header for restrict.c
  **/
 
 #ifndef TOR_RESTRICT_H
diff --git a/src/lib/process/setuid.c b/src/lib/process/setuid.c
index fa1cdc0f3f..5423259a66 100644
--- a/src/lib/process/setuid.c
+++ b/src/lib/process/setuid.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file setuid.c
+ * \brief Change the user ID after Tor has started (Unix only)
+ **/
+
 #include "orconfig.h"
 #include "lib/process/setuid.h"
 
diff --git a/src/lib/process/setuid.h b/src/lib/process/setuid.h
index 61aeefe1b7..49751c97c2 100644
--- a/src/lib/process/setuid.h
+++ b/src/lib/process/setuid.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file setuid.h
+ * \brief Header for setuid.c
+ **/
+
 #ifndef TOR_SETUID_H
 #define TOR_SETUID_H
 
diff --git a/src/lib/process/subprocess.c b/src/lib/process/subprocess.c
index 516494d105..9a12f5e76e 100644
--- a/src/lib/process/subprocess.c
+++ b/src/lib/process/subprocess.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file subprocess.c
+ * \brief Launch and monitor other processes.
+ **/
+
 #define SUBPROCESS_PRIVATE
 #include "lib/process/subprocess.h"
 
diff --git a/src/lib/process/subprocess.h b/src/lib/process/subprocess.h
index a319b3505c..5b4318ef2b 100644
--- a/src/lib/process/subprocess.h
+++ b/src/lib/process/subprocess.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file subprocess.h
+ * \brief Header for subprocess.c
+ **/
+
 #ifndef TOR_SUBPROCESS_H
 #define TOR_SUBPROCESS_H
 
diff --git a/src/lib/process/waitpid.c b/src/lib/process/waitpid.c
index 66c77b05f3..27f69b08f0 100644
--- a/src/lib/process/waitpid.c
+++ b/src/lib/process/waitpid.c
@@ -4,10 +4,8 @@
 /* See LICENSE for licensing information */
 
 /**
- * \file util_process.c
- * \brief utility functions for launching processes and checking their
- *    status. These functions are kept separately from procmon so that they
- *    won't require linking against libevent.
+ * \file waitpid.c
+ * \brief Convenience structures for handlers for handling waitpid().
  **/
 
 #include "orconfig.h"