From 9710af5a3583fa082f576cf42cdf4cb92a36daf9 Mon Sep 17 00:00:00 2001 From: Aleksander Kaminski Date: Fri, 29 Nov 2024 13:50:27 +0100 Subject: [PATCH] coding: Update file header convention DONE: RTOS-980 --- coding/index.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/coding/index.md b/coding/index.md index 0cd684e4..101fef60 100644 --- a/coding/index.md +++ b/coding/index.md @@ -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 + /* + * + * + * + * + * + * + * Copyright Phoenix Systems + * Author: + * + * %LICENSE% + */ +``` + +Example of a file that is a part of the Phoenix-RTOS kernel: ```c /* @@ -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% */ ``` @@ -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: