X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/460b9539a7c15580e41a71bbc0f47ae776238915..a4243347741f0f7079858e03bca8fc32990f525c:/lib/sink.h

diff --git a/lib/sink.h b/lib/sink.h
index f19a0c6..15462ae 100644
--- a/lib/sink.h
+++ b/lib/sink.h
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder
- * Copyright (C) 2004 Richard Kettlewell
+ * Copyright (C) 2004, 2007, 2008 Richard Kettlewell
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,17 +17,29 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file lib/sink.h
+ * @brief Abstract output sink type
+ */
 
 #ifndef SINK_H
 #define SINK_H
 
-/* a sink is something you write to (the opposite would be a source) */
-
 struct dynstr;
 
+/** @brief Sink type
+ *
+ * A sink is something you write bytes to; the opposite would be a
+ * source.  We provide sink_stdio() and sink_dynstr() to create sinks
+ * to write to stdio streams and dynamic strings.
+ */
 struct sink {
+  /** @brief Write callback
+   * @param s Sink to write to
+   * @param buffer First byte to write
+   * @param nbytes Number of bytes to write
+   * @return non-negative on success, -1 on error
+   */
   int (*write)(struct sink *s, const void *buffer, int nbytes);
-  /* return >= 0 on success, -1 on error */
 };
 
 struct sink *sink_stdio(const char *name, FILE *fp);
@@ -38,19 +50,38 @@ struct sink *sink_stdio(const char *name, FILE *fp);
 struct sink *sink_dynstr(struct dynstr *output);
 /* return a sink which appends to @output@. */
 
+struct sink *sink_discard(void);
+/* reutrn a sink which junks everything */
+
 int sink_vprintf(struct sink *s, const char *fmt, va_list ap);
 int sink_printf(struct sink *s, const char *fmt, ...)
   attribute((format (printf, 2, 3)));
 /* equivalent of vfprintf/fprintf for sink @s@ */
 
+/** @brief Write bytes to a sink
+ * @param s Sink to write to
+ * @param buffer First byte to write
+ * @param nbytes Number of bytes to write
+ * @return non-negative on success, -1 on error
+ */
 static inline int sink_write(struct sink *s, const void *buffer, int nbytes) {
   return s->write(s, buffer, nbytes);
 }
 
+/** @brief Write string to a sink
+ * @param s Sink to write to
+ * @param str String to write
+ * @return non-negative on success, -1 on error
+ */
 static inline int sink_writes(struct sink *s, const char *str) {
   return s->write(s, str, strlen(str));
 }
 
+/** @brief Write one byte to a sink
+ * @param s Sink to write to
+ * @param c Byte to write (as a @c char)
+ * @return non-negative on success, -1 on error
+ */
 static inline int sink_writec(struct sink *s, char c) {
   return s->write(s, &c, 1);
 }
@@ -64,4 +95,3 @@ c-basic-offset:2
 comment-column:40
 End:
 */
-/* arch-tag:2f4f2c2a4e65aef8f7c59b4785121083 */