1*3117ece4Schristosgen_html - a program for automatic generation of zstd manual 2*3117ece4Schristos============================================================ 3*3117ece4Schristos 4*3117ece4Schristos#### Introduction 5*3117ece4Schristos 6*3117ece4SchristosThis simple C++ program generates a single-page HTML manual from `zstd.h`. 7*3117ece4Schristos 8*3117ece4SchristosThe format of recognized comment blocks is following: 9*3117ece4Schristos- comments of type `/*!` mean: this is a function declaration; switch comments with declarations 10*3117ece4Schristos- comments of type `/**` and `/*-` mean: this is a comment; use a `<H2>` header for the first line 11*3117ece4Schristos- comments of type `/*=` and `/**=` mean: use a `<H3>` header and show also all functions until first empty line 12*3117ece4Schristos- comments of type `/*X` where `X` is different from above-mentioned are ignored 13*3117ece4Schristos 14*3117ece4SchristosMoreover: 15*3117ece4Schristos- `ZSTDLIB_API` is removed to improve readability 16*3117ece4Schristos- `typedef` are detected and included even if uncommented 17*3117ece4Schristos- comments of type `/**<` and `/*!<` are detected and only function declaration is highlighted (bold) 18*3117ece4Schristos 19*3117ece4Schristos 20*3117ece4Schristos#### Usage 21*3117ece4Schristos 22*3117ece4SchristosThe program requires 3 parameters: 23*3117ece4Schristos``` 24*3117ece4Schristosgen_html [zstd_version] [input_file] [output_html] 25*3117ece4Schristos``` 26*3117ece4Schristos 27*3117ece4SchristosTo compile program and generate zstd manual we have used: 28*3117ece4Schristos``` 29*3117ece4Schristosmake 30*3117ece4Schristos./gen_html.exe 1.1.1 ../../lib/zstd.h zstd_manual.html 31*3117ece4Schristos``` 32