projects
/
onak.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Update Debian Vcs-* fields to point to git repository
[onak.git]
/
charfuncs.h
diff --git
a/charfuncs.h
b/charfuncs.h
index b09edf375cf58d33bbb61a06890817c7b992e491..19f38f82279917299128c1e9e1ba4f2190f57a61 100644
(file)
--- 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__
*/
#ifndef __CHARFUNCS_H__
@@
-12,54
+24,54
@@
#include <stdlib.h>
/**
#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 {
*/
struct buffer_ctx {
+ /** The data buffer. */
char *buffer;
char *buffer;
+ /** Our current position in the buffer. */
size_t offset;
size_t offset;
+ /** The size of the data buffer. */
size_t size;
};
/**
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, void *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, void *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, void *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, void *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, void *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, void *c);
*/
int stdout_putchar(void *ctx, size_t count, void *c);