From 0edc44f8dc10cb461dfe69b7665776b993085225 Mon Sep 17 00:00:00 2001 From: Patrick Vogler Date: Wed, 21 Jun 2023 14:28:34 +0000 Subject: [PATCH] Update 'Coding Style' --- Coding-Style.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/Coding-Style.md b/Coding-Style.md index 13cf6d7..54ada0e 100644 --- a/Coding-Style.md +++ b/Coding-Style.md @@ -15,15 +15,7 @@ This document discusses practices and style for programmers working on the BigWh

## Content -- [The Single Most Important Rule](#the-single-most-important-rule) -- [Formatting](#formatting) - - [Indentation](#indentation) - - [Braces](#braces) - - [Functions](#functions) - - [Derived Types](#derived-types) -- [Comments](#comments) -- [Syntactic Conventions](#syntactic_conventions) -- [Names](#names) + ## The Single Most Important Rule Above all, the following rule from the GNOME developer documentation should always be followed. @@ -51,7 +43,23 @@ while ((c = *str++)) } ``` Continuation lines should align wrapped elements either vertically using Python’s implicit line joining inside parentheses, brackets and braces, or using a hanging indent [1]. When using a hanging indent the following should be considered; there should be no arguments on the first line and further indentation should be used to clearly distinguish itself as a continuation line: - +```c +error = initialize_tagtree(&prec_control->tag_inclusion, + prec_control->numCbX, + prec_control->numCbY, + prec_control->numCbZ, + prec_control->numCbTS) +exit(error); +``` +```c +error = initialize_tagtree( + &prec_control->tag_inclusion, + prec_control->numCbX, + prec_control->numCbY, + prec_control->numCbZ, + prec_control->numCbTS); +exit(error); +``` ### Braces ```c prec_control->numCodeblocks_a = (uint64)(prec_control->numCbX