mirrors/lz4
0
0
Fork 0
mirror of https://github.com/lz4/lz4.git synced 2024-11-23 18:04:05 +08:00
Code Issues Packages Projects Releases Wiki Activity
45fda541f0
lz4/contrib/gen_manual
History
LocalSpook e270f2edd9 Make Makefile version number parsing more robust
2023-10-11 18:58:47 -07:00
..
.gitignore updated Makefile 2017-05-10 13:26:04 -07:00
gen_manual.cpp Optimized by replacing endl with '\n' 2020-07-23 20:13:14 -04:00
gen-lz4-manual.sh Make Makefile version number parsing more robust 2023-10-11 18:58:47 -07:00
Makefile Make Makefile version number parsing more robust 2023-10-11 18:58:47 -07:00
README.md minor typo 2016-11-10 18:02:56 -08:00

README.md

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

Introduction

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)

Usage

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