X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=string.h;h=10251ae7c10b734bd906a644e0832e29b9e6bd9c;hp=52f989417d8071a1f2ed33d99ce7fd8ba18d66c1;hb=5ceb90b647125035d52ae935a7fdae037b5b50a4;hpb=b52342d0b5df5446f149f0c1daf26f6e25b2aba7 diff --git a/string.h b/string.h index 52f98941..10251ae7 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,14 +48,14 @@ 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) { \