mirror of
https://github.com/facebook/zstd.git
synced 2025-03-07 01:10:04 +02:00
5d693cc38c
``` for f in $(find . \( -path ./.git -o -path ./tests/fuzz/corpora -o -path ./tests/regression/data-cache -o -path ./tests/regression/cache \) -prune -o -type f); do sed -i '/Copyright .* \(Yann Collet\)\|\(Meta Platforms\)/ s/Copyright .*/Copyright (c) Meta Platforms, Inc. and affiliates./' $f; done git checkout HEAD -- build/VS2010/libzstd-dll/libzstd-dll.rc build/VS2010/zstd/zstd.rc tests/test-license.py contrib/linux-kernel/test/include/linux/xxhash.h examples/streaming_compression_thread_pool.c lib/legacy/zstd_v0*.c lib/legacy/zstd_v0*.h nano ./programs/windres/zstd.rc nano ./build/VS2010/zstd/zstd.rc nano ./build/VS2010/libzstd-dll/libzstd-dll.rc ```
gen_html - a program for automatic generation of zstd manual
Introduction
This simple C++ program generates a single-page HTML manual from zstd.h.
The format of recognized comment blocks is following:
- comments of type
/*!mean: this is a function declaration; switch comments with declarations - comments of type
/**and/*-mean: this is a comment; use a<H2>header for the first line - comments of type
/*=and/**=mean: use a<H3>header and show also all functions until first empty line - comments of type
/*XwhereXis different from above-mentioned are ignored
Moreover:
ZSTDLIB_APIis removed to improve readabilitytypedefare detected and included even if uncommented- comments of type
/**<and/*!<are detected and only function declaration is highlighted (bold)
Usage
The program requires 3 parameters:
gen_html [zstd_version] [input_file] [output_html]
To compile program and generate zstd manual we have used:
make
./gen_html.exe 1.1.1 ../../lib/zstd.h zstd_manual.html