X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=string.h;h=08b9965f57d94b52a19dd231c38b2d53aabb824a;hb=fefff8660daa86834673fdcc284ebe5d02c1d37b;hp=aa8292fdf4ec1f076294842e1b6cb02dbc4f23a6;hpb=8daabd03bb649ae04d6b2dd9e46640ca1e514d3d;p=paraslash.git diff --git a/string.h b/string.h index aa8292fd..08b9965f 100644 --- a/string.h +++ b/string.h @@ -1,8 +1,4 @@ -/* - * Copyright (C) 2006 Andre Noll - * - * Licensed under the GPL v2. For licencing details see COPYING. - */ +/* Copyright (C) 2006 Andre Noll , see file COPYING. */ /** \file string.h exported symbols from string.c */ @@ -20,7 +16,7 @@ struct para_buffer { size_t size; /** The maximal size this buffer may grow. Zero means unlimited. */ size_t max_size; - /** \sa para_buffer_flags. */ + /** \sa \ref para_buffer_flags. */ unsigned flags; /** The next para_printf() will write at this offset. */ size_t offset; @@ -37,7 +33,7 @@ struct para_buffer { /** * Controls the behavior of for_each_line(). * - * \sa for_each_line(). + * \sa \ref for_each_line(). */ enum for_each_line_flags { /** Activate read-only mode. */ @@ -52,18 +48,18 @@ int for_each_line(unsigned flags, char *buf, size_t size, line_handler_t *line_handler, void *private_data); /** - * Write the contents of a status item to a para_buffer. - * - * \param b The para_buffer. - * \param n The number of the status item. - * \param f A format string. - * - * \return The return value of the underlying call to para_printf(). - */ + * Write the contents of a status item to a para_buffer. + * + * \param b The para_buffer. + * \param n The number of the status item. + * \param f A format string. + * + * \return The return value of the underlying call to \ref para_printf(). + */ #define WRITE_STATUS_ITEM(b, n, f, ...) (\ { \ if ((b)->flags & PBF_SIZE_PREFIX) { \ - para_printf((b), "%02x:" f, n, ## __VA_ARGS__); \ + para_printf((b), "%02x:" f, (unsigned)n, ## __VA_ARGS__); \ } else { \ para_printf((b), "%s: " f, status_item_list[(n)], \ ## __VA_ARGS__); \ @@ -71,7 +67,7 @@ int for_each_line(unsigned flags, char *buf, size_t size, } \ ) -__must_check __malloc void *para_realloc(void *p, size_t size); +__must_check void *para_realloc(void *p, size_t size); __must_check __malloc void *para_malloc(size_t size); __must_check __malloc void *para_calloc(size_t size); __must_check __malloc char *para_strdup(const char *s); @@ -80,8 +76,6 @@ __printf_2_0 unsigned xvasprintf(char **result, const char *fmt, va_list ap); __printf_2_3 unsigned xasprintf(char **result, const char *fmt, ...); __must_check __malloc __printf_1_2 char *make_message(const char *fmt, ...); __must_check __malloc char *para_strcat(char *a, const char *b); -__must_check __malloc char *para_dirname(const char *name); -__must_check char *para_basename(const char *name); __must_check __malloc char *para_logname(void); __must_check __malloc char *para_homedir(void); __malloc char *para_hostname(void);