~emersion/gyosu

3bdbf439b86e2867dbc39f5510c63ceb9a6aa7d1 — Simon Ser 14 days ago 643a670
readme: add section about doc comment formatting
1 files changed, 13 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +13 -0
@@ 20,6 20,19 @@ Example:
      -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