mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-29 18:08:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Update conventions with function typedefs

Browse source
This commit is contained in:
Jakob Bornecrantz 2022-05-17 15:48:59 +01:00
parent cf9c5b9dc7
commit 01a4605cf4
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/conventions.md
View file

@ -50,7 +50,10 @@ directed-acyclic-graph.
*implemented* in other modules.)
- Generally, we do not declare typedefs for `struct` and `enum` types, but
instead refer to them in long form, saying `struct` or `enum` then the name.
- If a typedef is needed, it should be named ending with `_t`.
The exception to not using typedefs is function pointers used as function
arguments as these become very hard to both read and type out.
- If a typedef is needed, it should be named ending with `_t`. Function
pointer typedefs should end with `_func_t`.
- Parameters: `lower_snake_case` or acronyms.
- Output parameters should begin with `out_`.
- Of special note: Structures/types that represent "objects" often have long