friendlyelec
/
rk35xx-android12
1
0
Fork 0
Code Releases Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '43b37c51fa'
${ noResults }
rk35xx-android12/external/zstd/contrib/gen_html
History
hmz007 6d24f2138b
Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 		3 years ago
..
.gitignore Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago
Makefile Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago
README.md Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago
gen-zstd-manual.sh Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago
gen_html.cpp Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago

README.md

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 /*X where X is different from above-mentioned are ignored

Moreover:

  • ZSTDLIB_API is removed to improve readability
  • typedef are 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