From aff82483411bc8c505ef024ad18778fc902fdbe3 Mon Sep 17 00:00:00 2001 From: Bob Andrews Date: Sun, 8 Sep 2024 17:08:40 +0200 Subject: [PATCH] add comment on function prototypes --- Contributing.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Contributing.md b/Contributing.md index 5b53e0467..10d687424 100644 --- a/Contributing.md +++ b/Contributing.md @@ -204,6 +204,18 @@ char* nextLine (FILE* f); ### Header files +* All Headers should start with a copyright/license banner +* Function prototypes must be a single line, not contain the redundant + "extern" keyword, and followed by a brief comment that explains what + the function does, and separated from the next prototype by a blank + line: + +~~~C +void __fastcall__ cclear (unsigned char length); +/* Clear part of a line (write length spaces). */ + +~~~ + Headers that belong to the standard library (libc) must conform with the C standard. That means: