From: Andre Noll <maan@systemlinux.org>
Date: Sun, 23 Sep 2007 18:35:26 +0000 (+0200)
Subject: stdin.h, stdout.h: Trivial documentation cleanup.
X-Git-Tag: v0.3.0~368
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=d5957972a5b29a0e88883244d1745320aba6835a

stdin.h, stdout.h: Trivial documentation cleanup.
---

diff --git a/stdin.h b/stdin.h
index 6931f330..4f5a6112 100644
--- a/stdin.h
+++ b/stdin.h
@@ -1,26 +1,24 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file stdin.h the stdin task structure and exported symbols from stdin.c */
+/** \file stdin.h The standard in task structure. */
 
-/**
- * the task structure used for reading from stdin
- */
+/** The task structure used for reading from stdin. */
 struct stdin_task {
-	/** input buffer */
+	/** Input buffer. */
 	char *buf;
-	/** the size of \a buf */
+	/** The size of \a buf. */
 	size_t bufsize;
-	/** number of bytes currently loaded in \a buf */
+	/** Number of bytes currently loaded in \a buf. */
 	size_t loaded;
-	/** whether \p STDIN_FILENO was included in the read fd set */
+	/** Whether \p STDIN_FILENO was included in the read fd set. */
 	int check_fd;
-	/** the task structure */
+	/** The task structure. */
 	struct task task;
-	/** non-zero on read error, or if a read from stdin returned zero */
+	/** Non-zero on read error, or if a read from stdin returned zero. */
 	int eof;
 };
 
diff --git a/stdout.h b/stdout.h
index f69a024b..ee4f35ff 100644
--- a/stdout.h
+++ b/stdout.h
@@ -4,23 +4,23 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file stdout.h the stdout task structure and exported symbols from stdout.c */
+/** \file stdout.h The standard out task structure. */
 
 /**
- * the task structure used for writing to stdout
+ * The task structure used for writing to stdout.
  */
 struct stdout_task {
-	/** pointer to the data buffer */
+	/** Pointer to the data buffer. */
 	char *buf;
-	/** number of bytes loaded in \a buf */
+	/** Number of bytes loaded in \a buf. */
 	size_t *loaded;
-	/** pointer to the eof flag of the feeding task */
+	/** Üointer to the eof flag of the feeding task. */
 	int *input_eof;
-	/** non-zero if a write error occured */
+	/** Non-zero if a write error occured. */
 	int eof;
-	/** the task structure */
+	/** The task structure. */
 	struct task task;
-	/** whether \p STDOUT_FILENO was included in the write fd set */
+	/** Whether \p STDOUT_FILENO was included in the write fd set. */
 	int check_fd;
 };