This utility accepts an SQLite header file
sqlite3.h and produces a set of decently well-formed
mdoc(7) files
documenting the C API.
These will be roughly equivalent to the C-language Interface
Specification for SQLite.
You can also use it for any file(s) using the documentation standards of SQLite. See the sqlite2mdoc.1 manpage for syntax details.
Note: this only works with sqlite3, not the original sqlite.h
format.
Release snapshots are archived in https://kristaps.bsd.lv/sqlite2mdoc/snapshots.
Run ./configure then make.
This utility isn't meant for installation, but for integration into your
SQLite deployment phase. You can run make install, however, if you
plan on using it for other documentation.
There are no compile-time or run-time dependencies.
This software has been tested and run on OpenBSD, FreeBSD, NetBSD, IllumOS, Solaris, Mac OS X, and Linux (glibc and musl).
I've used mandoc to generate some Markdown from the mdoc(7) output.
The system is tested using Valgrind, AFL and
now AFLplusplus, and the ASAN and UBSAN
compiler flags. These are run over the make regress regression
analysis. They may be run manually or as part of the CI.
For AFL and AFL++, the afl directory contains a simple seed input
file.
All sources use the ISC (like OpenBSD) license. See the LICENSE.md file for details.