From 57b56304229c2c8bd7416ff7c4f7d18563a165b0 Mon Sep 17 00:00:00 2001 From: Billy Laws Date: Sat, 20 Jun 2020 20:33:24 +0100 Subject: [PATCH] Note that comments on virtual functions are optional in the contributing guidelines --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afb30f59..429f1c8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,6 +49,7 @@ Notes: * The `DeviceState` object or other objects which are systematically used throughout multiple classes such as `ServiceManager` can be skipped from function argument documentation as well as class members in the constructor * The `KSession`, `IpcRequest` and `IpcResponse` objects in IPC command function arguments and other such objects (Such as `IoctlData`) can be skipped from function argument documentation if used in those contexts, they will need to be documented if they're used as a class member or something on those lines * Any class members don't need to be redundantly documented in the constructor +* Comments on virtual functions are optional ### Spacing We generally follow the rule of **"Functional Spacing"**, that being spacing between chunks of code that do something functionally different while functionally similar blocks of code can be closer together.