X-Git-Url: https://git.sommitrealweird.co.uk/onak.git/blobdiff_plain/394938c479925750ffe56c28d281945ba4003a14..b7a8b5277d37b289361ff0cc881632f527e4d5db:/charfuncs.h

diff --git a/charfuncs.h b/charfuncs.h
index ad460e4..19f38f8 100644
--- a/charfuncs.h
+++ b/charfuncs.h
@@ -1,9 +1,21 @@
-/*
- * charfuncs.h - Routines for dealing with character streams.
+/**
+ * @file charfuncs.h
+ * @brief Routines for dealing with character streams.
+ *
+ * Copyright 2002 Jonathan McDowell <noodles@earth.li>
+ *
+ * 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 the Free
+ * Software Foundation; version 2 of the License.
  *
- * Jonathan McDowell <noodles@earth.li>
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
  *
- * Copyright 2002 Project Purple
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #ifndef __CHARFUNCS_H__
@@ -12,55 +24,55 @@
 #include <stdlib.h>
 
 /**
- *	buffer_ctx - Shared with CGI buffer stuff...
- *	@buffer: The data buffer.
- *	@offset: Our current position in the buffer.
- *	@size: The size of the data buffer.
+ * @brief Shared with CGI buffer stuff...
  */
 struct buffer_ctx {
+	/** The data buffer. */
 	char *buffer;
+	/** Our current position in the buffer. */
 	size_t offset;
+	/** The size of the data buffer. */
 	size_t size;
 };
 
 /**
- *	buffer_fetchchar - Fetches a char from a buffer.
- *	@ctx: Our buffer context structure.
- *	@count: The number of characters to get from the buffer.
- *	@c: Where to put the characters retrieved.
+ * @brief Fetches a char from a buffer.
+ * @param ctx Our buffer context structure.
+ * @param count The number of characters to get from the buffer.
+ * @param c Where to put the characters retrieved.
  */
-int buffer_fetchchar(void *ctx, size_t count, unsigned char *c);
+int buffer_fetchchar(void *ctx, size_t count, void *c);
 
 /**
- *	buffer_putchar - Puts a char to a buffer.
- *	@ctx: Our buffer context structure.
- *	@count: The number of characters to put into the buffer.
- *	@c: The characters to add to the buffer.
+ * @brief Puts a char to a buffer.
+ * @param ctx Our buffer context structure.
+ * @param count The number of characters to put into the buffer.
+ * @param c The characters to add to the buffer.
  *
- *	Adds characters to the buffer references by the buffer context. If we
- *	fill it then we double the size of the current buffer and then add the
- *	rest.
+ * Adds characters to the buffer references by the buffer context. If we
+ * fill it then we double the size of the current buffer and then add the
+ * rest.
  */
-int buffer_putchar(void *ctx, size_t count, unsigned char *c);
+int buffer_putchar(void *ctx, size_t count, void *c);
 
 /**
- *	file_fetchchar - Fetches a char from a file.
+ * @brief Fetches a char from a file.
  */
-int file_fetchchar(void *fd, size_t count, unsigned char *c);
+int file_fetchchar(void *fd, size_t count, void *c);
 
 /**
- *	file_putchar - Puts a char to a file.
+ * @brief Puts a char to a file.
  */
-int file_putchar(void *fd, size_t count, unsigned char *c);
+int file_putchar(void *fd, size_t count, void *c);
 
 /**
- *	stdin_getchar - Gets a char from stdin.
+ * @brief Gets a char from stdin.
  */
-int stdin_getchar(void *ctx, size_t count, unsigned char *c);
+int stdin_getchar(void *ctx, size_t count, void *c);
 
 /**
- *	stdout_putchar - Puts a char to stdout.
+ * @brief Puts a char to stdout.
  */
-int stdout_putchar(void *ctx, size_t count, unsigned char *c);
+int stdout_putchar(void *ctx, size_t count, void *c);
 
 #endif /* __CHARFUNCS_H__ */