docs: Improve code style guideline
This commit is contained in:
parent
6a72e73d0c
commit
9cc248a1af
1 changed files with 42 additions and 0 deletions
|
@ -23,6 +23,48 @@ Comment blocks should be formatted as following:
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Structs and Enums
|
||||||
|
|
||||||
|
Structures and enums are formatted as following:
|
||||||
|
|
||||||
|
```c
|
||||||
|
struct _FooBar
|
||||||
|
{
|
||||||
|
guint32 field_one;
|
||||||
|
gchar *text;
|
||||||
|
};
|
||||||
|
|
||||||
|
typedef struct
|
||||||
|
{
|
||||||
|
FooParent parent;
|
||||||
|
|
||||||
|
guint32 field_one;
|
||||||
|
gchar *text;
|
||||||
|
|
||||||
|
struct
|
||||||
|
{
|
||||||
|
CustomType *something;
|
||||||
|
guint something_else;
|
||||||
|
} inner_struct;
|
||||||
|
|
||||||
|
gboolean flag : 1;
|
||||||
|
} FooBar;
|
||||||
|
|
||||||
|
enum
|
||||||
|
{
|
||||||
|
FIRST,
|
||||||
|
SECOND,
|
||||||
|
LAST,
|
||||||
|
};
|
||||||
|
|
||||||
|
typedef enum
|
||||||
|
{
|
||||||
|
FOO_BAR_FIRST,
|
||||||
|
FOO_BAR_SECOND,
|
||||||
|
FOO_BAR_LAST,
|
||||||
|
} FooEnumBar;
|
||||||
|
```
|
||||||
|
|
||||||
## Header (.h) files
|
## Header (.h) files
|
||||||
|
|
||||||
It is organized by the following structure:
|
It is organized by the following structure:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue