diff options
author | Nick Mathewson <nickm@torproject.org> | 2012-06-04 18:50:13 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2012-06-04 19:05:51 -0400 |
commit | f68c042637d253dfb3160357ba2b9ec530cb48ef (patch) | |
tree | 621b700acf4646a720d47b719b30d5ebf2d51ed1 /src/common | |
parent | 41e8bee188571ca61c2f5628ea99dff34343d673 (diff) | |
download | tor-f68c042637d253dfb3160357ba2b9ec530cb48ef.tar.gz tor-f68c042637d253dfb3160357ba2b9ec530cb48ef.zip |
Resolve all currently pending DOCDOC items in master
Diffstat (limited to 'src/common')
-rw-r--r-- | src/common/compat.c | 3 | ||||
-rw-r--r-- | src/common/util.c | 12 | ||||
-rw-r--r-- | src/common/util.h | 4 |
3 files changed, 15 insertions, 4 deletions
diff --git a/src/common/compat.c b/src/common/compat.c index 093106120d..49a4afe733 100644 --- a/src/common/compat.c +++ b/src/common/compat.c @@ -143,7 +143,8 @@ tor_open_cloexec(const char *path, int flags, unsigned mode) return fd; } -/** DOCDOC */ +/** As fpoen(path,mode), but ensures that the O_CLOEXEC bit is set on the + * underlying file handle. */ FILE * tor_fopen_cloexec(const char *path, const char *mode) { diff --git a/src/common/util.c b/src/common/util.c index e7979d85b5..b3145aefe3 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -3323,7 +3323,15 @@ process_handle_new(void) return out; } -/*DOCDOC*/ +/** + * @name child-process states + * + * Each of these values represents a possible state that a child process can + * be in. They're used to determine what to say when telling the parent how + * far along we were before failure. + * + * @{ + */ #define CHILD_STATE_INIT 0 #define CHILD_STATE_PIPE 1 #define CHILD_STATE_MAXFD 2 @@ -3334,7 +3342,7 @@ process_handle_new(void) #define CHILD_STATE_CLOSEFD 7 #define CHILD_STATE_EXEC 8 #define CHILD_STATE_FAILEXEC 9 - +/** @} */ /** Start a program in the background. If <b>filename</b> contains a '/', then * it will be treated as an absolute or relative path. Otherwise, on * non-Windows systems, the system path will be searched for <b>filename</b>. diff --git a/src/common/util.h b/src/common/util.h index 36601fa790..ae40898de7 100644 --- a/src/common/util.h +++ b/src/common/util.h @@ -409,8 +409,10 @@ void set_environment_variable_in_smartlist(struct smartlist_t *env_vars, #define PROCESS_STATUS_ERROR -1 #ifdef UTIL_PRIVATE -/*DOCDOC*/ +/** Structure to represent the state of a process with which Tor is + * communicating. The contents of this structure are private to util.c */ struct process_handle_t { + /** One of the PROCESS_STATUS_* values */ int status; #ifdef _WIN32 HANDLE stdout_pipe; |