gyosu

gyosu

A simple C documentation generator.

Example output: I maintain the documentation for the wlroots API on my website.

Building

go build .

Usage

gyosu [options...] <headers...>

Example:

gyosu \
  $(pkg-config --cflags-only-I wlroots) \
  -DWLR_USE_UNSTABLE \
  -ffile-prefix-map=/usr/include/= \
  /usr/include/wlr/types/wlr_output.h

Comment formatting

All documentation comments must use /** … */.

To reference another declaration from a documentation comment, the following notations are recognized:

• struct foo
• enum foo
• union foo
• foo()
• <foo.h>

Contributing

Send patches on the mailing list, report bugs on the issue tracker, discuss in #emersion on Libera Chat.

License

AGPLv3, see LICENSE.

Copyright (C) 2021 Simon Ser