Skip to content

Commit

Permalink
coding: Update file header convention
Browse files Browse the repository at this point in the history
DONE: RTOS-980
  • Loading branch information
agkaminski authored and nalajcie committed Nov 29, 2024
1 parent 1e74783 commit 9710af5
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions coding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,24 @@ In general code should be compliant with C99 (without GNU extensions) standard.

## File label

Each operating system source file is marked with label with the following structure.
Each operating system source file is marked with label with the following structure:

```c
/*
* <Project name>
*
* <Name of the software module, optional>
*
* <Brief file description>
*
* Copyright <Years of active development> Phoenix Systems
* Author: <List of authors>
*
* %LICENSE%
*/
```

Example of a file that is a part of the Phoenix-RTOS kernel:

```c
/*
Expand All @@ -22,8 +39,6 @@ Each operating system source file is marked with label with the following struct
* Copyright 2005-2006 Pawel Pisarczyk
* Author: Pawel Pisarczyk, Radoslaw F. Wawrzusiak, Jacek Popko
*
* This file is part of Phoenix-RTOS.
*
* %LICENSE%
*/
```
Expand Down Expand Up @@ -208,7 +223,7 @@ One space character should be used after and before the following binary and ter
No space should be used after the following unary operators:

```c
& * + - ~ !
& * + - ~ !
```

The `sizeof` and `typeof`are treated as functions and are to be used in accordance to the following notation:
Expand Down

0 comments on commit 9710af5

Please sign in to comment.