X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib/blobdiff_plain/0683223aa93d14e4b1d0620010392c518a3a6392..d4efbcd93c940ad522fcf8c601ec1829d2e0b10d:/sub.h diff --git a/sub.h b/sub.h index 0731027..78e646e 100644 --- a/sub.h +++ b/sub.h @@ -7,7 +7,7 @@ * (c) 1998 Straylight/Edgeware */ -/*----- Licensing notice --------------------------------------------------* +/*----- Licensing notice --------------------------------------------------* * * This file is part of the mLib utilities library. * @@ -15,12 +15,12 @@ * it under the terms of the GNU Library General Public License as * published by the Free Software Foundation; either version 2 of the * License, or (at your option) any later version. - * + * * mLib 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 Library General Public License for more details. - * + * * You should have received a copy of the GNU Library General Public * License along with mLib; if not, write to the Free * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, @@ -134,9 +134,9 @@ extern void subarena_destroy(subarena */*s*/); * Arguments: @subarena *s@ = pointer to arena * @size_t s@ = size of chunk wanted * - * Returns: Pointer to a block at least as large as the one wanted. + * Returns: Pointer to a block at least as large as the one wanted. * - * Use: Allocates a small block of memory from the given pool. The + * Use: Allocates a small block of memory from the given pool. The * exception @EXC_NOMEM@ is raised if the underlying arena is * full. */ @@ -145,13 +145,13 @@ extern void *subarena_alloc(subarena */*s*/, size_t /*sz*/); /* --- @subarena_free@ --- * * - * Arguments: @subarena *s@ = pointer to arena + * Arguments: @subarena *s@ = pointer to arena * @void *p@ = address of block to free - * @size_t s@ = size of block + * @size_t s@ = size of block * - * Returns: --- + * Returns: --- * - * Use: Frees a block allocated by @subarena_alloc@. + * Use: Frees a block allocated by @subarena_alloc@. */ extern void subarena_free(subarena */*s*/, void */*p*/, size_t /*sz*/); @@ -186,11 +186,11 @@ extern void subarena_free(subarena */*s*/, void */*p*/, size_t /*sz*/); /* --- @sub_alloc@ --- * * - * Arguments: @size_t s@ = size of chunk wanted + * Arguments: @size_t s@ = size of chunk wanted * - * Returns: Pointer to a block at least as large as the one wanted. + * Returns: Pointer to a block at least as large as the one wanted. * - * Use: Allocates a small block of memory from the @sub_global@ pool. + * Use: Allocates a small block of memory from the @sub_global@ pool. */ extern void *sub_alloc(size_t /*sz*/); @@ -198,12 +198,12 @@ extern void *sub_alloc(size_t /*sz*/); /* --- @sub_free@ --- * * - * Arguments: @void *p@ = address of block to free - * @size_t s@ = size of block + * Arguments: @void *p@ = address of block to free + * @size_t s@ = size of block * - * Returns: --- + * Returns: --- * - * Use: Frees a block allocated by @sub_alloc@. + * Use: Frees a block allocated by @sub_alloc@. */ extern void sub_free(void */*p*/, size_t /*sz*/); @@ -235,11 +235,11 @@ extern void sub_free(void */*p*/, size_t /*sz*/); /* --- @sub_init@ --- * * - * Arguments: --- + * Arguments: --- * - * Returns: --- + * Returns: --- * - * Use: Initializes the magic allocator. This is no longer + * Use: Initializes the magic allocator. This is no longer * necessary. */