Updated styles.

This commit is contained in:
mibi88 2024-07-28 22:05:49 +02:00
parent cac86e35ff
commit 18ee9bcffe

View file

@ -2,32 +2,10 @@
(Mibi88) Fcalva, SlyVTT: What do you think of this?
Wrap the code on 80 columns. Align the wrapped code with the last parantheses,
etc.
Use curly braces with if, else, while and for statements if they can't hold on a
single line.
Put the curly braces after if, else, while or for statements and declarations of
procedures on the same line.
No spaces around parantheses, one space after a comma.
Variables names in sneak_case.
(Mibi88) SlyVTT, Fcalva, should be use a doc generation thing or do we describe
the procedures as I did so far?
Write your procedure name as following: `filename_whatitdoes`.
Document your procedures as following:
```C
/* procedure_name()
*
* Describe what this procedure does.
* arg1: Describe this argument. If the text is too long, wrap it to the
* next line like this.
* long_name: Describe this argument, and so on.
*/
```
The procedures are documented using sphinx.
Have I forgotten something?