~emersion/gyosu

ref: f0a1c44856f899704c0372f8b37099bc0acd1173 gyosu/README.md -rw-r--r-- 1.2 KiB
f0a1c448Simon Ser readme: link to example with wlroots API 2 months ago

#gyosu

builds.sr.ht status

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