ref: 3bdbf439b86e2867dbc39f5510c63ceb9a6aa7d1 gyosu/README.md -rw-r--r-- 1.1 KiB
3bdbf439Simon Ser readme: add section about doc comment formatting 2 months ago


builds.sr.ht status

A simple C documentation generator.


go build .


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


gyosu \
  $(pkg-config --cflags-only-I wlroots) \
  -ffile-prefix-map=/usr/include/= \

#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>


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



Copyright (C) 2021 Simon Ser