History

Yann Collet 5a10ed2f7b added cppcheck as Makefile target and Travis CI test. Fixed last cppcheck warnings in tests and examples		2018-09-18 16:52:02 -07:00
..
.gitignore	updated Makefile	2017-05-10 13:26:04 -07:00
gen_manual.cpp	added cppcheck	2018-09-18 16:52:02 -07:00
gen-lz4-manual.sh	updated gen-lz4-manual.sh	2017-01-23 16:33:03 +01:00
Makefile	fix #482 : change CFLAGS to CXXFLAGS	2018-03-09 11:54:32 -08:00
README.md	minor typo	2016-11-10 18:02:56 -08:00

gen_manual - a program for automatic generation of manual from source code

This simple C++ program generates a single-page HTML manual from lz4.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:

LZ4LIB_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)

The program requires 3 parameters:

gen_manual [lz4_version] [input_file] [output_html]

To compile program and generate lz4 manual we have used:

make
./gen_manual.exe 1.7.3 ../../lib/lz4.h lz4_manual.html