From e9b608deb1048cc85dcaf5cc36e2cb9c016d123e Mon Sep 17 00:00:00 2001 From: Patrick Vogler Date: Tue, 20 Jun 2023 14:14:34 +0000 Subject: [PATCH] Update 'Coding Style' --- Coding-Style.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/Coding-Style.md b/Coding-Style.md index 3324c42..1b1d143 100644 --- a/Coding-Style.md +++ b/Coding-Style.md @@ -12,4 +12,23 @@

This document discusses practices and style for programmers working on the BigWhoop compression library. The Guidelines are based on the C Coding Style recommended by the GNOME Developer Documentation and should be followed to promote a consistent, readable, and maintainable code base. The Guide offers solutions to common C, python and cmake programming issues and illustrates through examples of code -

\ No newline at end of file +

+ +## Table of Contents + +- [Recommended C style and coding rules](#recommended-c-style-and-coding-rules) + - [Table of Contents](#table-of-contents) + - [The single most important rule](#the-single-most-important-rule) + - [Integration with VSCode](#integration-with-vscode) + - [General rules](#general-rules) + - [Comments](#comments) + - [Functions](#functions) + - [Variables](#variables) + - [Structures, enumerations, typedefs](#structures-enumerations-typedefs) + - [Compound statements](#compound-statements) + - [Switch statement](#switch-statement) + - [Macros and preprocessor directives](#macros-and-preprocessor-directives) + - [Documentation](#documentation) + - [Header/source files](#headersource-files) + - [Artistic style configuration](#artistic-style-configuration) + - [Eclipse formatter](#eclipse-formatter) \ No newline at end of file