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

diff --git a/stdin.h b/stdin.h
index 6931f330f440ca9005fadbbc93e11178bd9bee02..4f5a6112feb8ded051560f95acc04ec03432fd29 100644 (file)
--- 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.
  */
 
  *
  * 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 {
 struct stdin_task {

-       /** input buffer */
+       /** Input buffer. */

        char *buf;
        char *buf;

-       /** the size of \a buf */
+       /** The size of \a buf. */

        size_t bufsize;
        size_t bufsize;

-       /** number of bytes currently loaded in \a buf */
+       /** Number of bytes currently loaded in \a buf. */

        size_t loaded;
        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;
        int check_fd;

-       /** the task structure */
+       /** The task structure. */

        struct task task;
        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;
 };
 
        int eof;
 };
 

diff --git a/stdout.h b/stdout.h
index f69a024bcfa457de7dd7b54e79e532b9c108df75..ee4f35ff924350d53db5360ffa8c889e30d00549 100644 (file)
--- a/stdout.h
+++ b/stdout.h
@@ -4,23 +4,23 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
  * 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 {
  */
 struct stdout_task {

-       /** pointer to the data buffer */
+       /** Pointer to the data buffer. */

        char *buf;
        char *buf;

-       /** number of bytes loaded in \a buf */
+       /** Number of bytes loaded in \a buf. */

        size_t *loaded;
        size_t *loaded;

-       /** pointer to the eof flag of the feeding task */
+       /** Üointer to the eof flag of the feeding task. */

        int *input_eof;
        int *input_eof;

-       /** non-zero if a write error occured */
+       /** Non-zero if a write error occured. */

        int eof;
        int eof;

-       /** the task structure */
+       /** The task structure. */

        struct task task;
        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;
 };
 
        int check_fd;
 };