NextGraph
/
rust-rocksdb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki 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.
1 Commit
1 Branch
0 Tags
44 MiB
 
 
 
 
 
 
Tag: Branch: Tree: c43e79ce9f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c43e79ce9f'
${ noResults }
rust-rocksdb/contrib/gen_manual
History
Niko PLP c43e79ce9f
Squashed 'librocksdb-sys/lz4/' content from commit 5ff83968 		1 year ago
..
.gitignore Squashed 'librocksdb-sys/lz4/' content from commit 5ff83968 1 year ago
Makefile Squashed 'librocksdb-sys/lz4/' content from commit 5ff83968 1 year ago
README.md Squashed 'librocksdb-sys/lz4/' content from commit 5ff83968 1 year ago
gen-lz4-manual.sh Squashed 'librocksdb-sys/lz4/' content from commit 5ff83968 1 year ago
gen_manual.cpp Squashed 'librocksdb-sys/lz4/' content from commit 5ff83968 1 year ago

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