From 5e55767557936eaca971ede6de4728d753fc8fb3 Mon Sep 17 00:00:00 2001 From: Patrick Steinhardt Date: Wed, 22 May 2019 20:55:24 +0200 Subject: [PATCH] docs: fix various warnings There's various warnings in the generated documentation either due to missing links or to mistaken use of simple comments `/* */` instead of docstyle comments `/** */`. Fix some of these by converting to docstyle comments or fixing the referenced function names. --- zzip/memdisk.c | 10 +++++----- zzip/zip.c | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/zzip/memdisk.c b/zzip/memdisk.c index f9088de..6be52cb 100644 --- a/zzip/memdisk.c +++ b/zzip/memdisk.c @@ -313,7 +313,7 @@ zzip_mem_entry_extra_block(ZZIP_MEM_ENTRY * entry, short datatype) return zzip_mem_entry_find_extra_block(entry, datatype, 16); } -/* get extra block. +/** get extra block. * This function finds an extra block for the given datatype code. * The returned EXTRA_BLOCK is still in disk-encoding but * already a pointer into an allocated heap space block. @@ -360,7 +360,7 @@ zzip_mem_entry_find_extra_block(ZZIP_MEM_ENTRY * entry, short datatype, zzip_siz } } -/** => zzip_mem_disk_unload +/** => zzip_mem_disk_close * This function ends usage of a file entry in a disk. */ void @@ -379,7 +379,7 @@ zzip_mem_entry_free(ZZIP_MEM_ENTRY * _zzip_restrict item) } } -/* => zzip_mem_disk_close +/** => zzip_mem_disk_close * This function will trigger an underlying disk_close */ void @@ -397,7 +397,7 @@ zzip_mem_disk_unload(ZZIP_MEM_DISK * dir) dir->disk = 0; } -/* end usage. +/** end usage. * This function closes the dir and disk handles. */ void @@ -545,7 +545,7 @@ error: return NULL; } -/** => zzip_mem_entry_open +/** => zzip_mem_disk_open * This function opens a file by name from an openend disk. */ zzip__new__ ZZIP_MEM_DISK_FILE * diff --git a/zzip/zip.c b/zzip/zip.c index bc6c080..66a6e50 100644 --- a/zzip/zip.c +++ b/zzip/zip.c @@ -654,7 +654,7 @@ zzip_dir_alloc(zzip_strings_t * fileext) return zzip_dir_alloc_ext_io(fileext, 0); } -/** => zzip_dir_alloc_ext_io +/** also: zzip_dir_alloc_ext_io * This function will free the zzip_dir handle unless there are still * zzip_files attached (that may use its cache buffer). * This is the inverse of => zzip_dir_alloc , and both -- 2.40.0