projects
/
paraslash.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
stdin.h, stdout.h: Trivial documentation cleanup.
[paraslash.git]
/
stdout.h
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;
};