From e097ed023c3c0cf98b368f57941b16a05725f481 Mon Sep 17 00:00:00 2001 From: max-001 Date: Wed, 6 Nov 2024 16:44:34 +0100 Subject: Added hyperlink to # documentation --- contributing.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 695b99b..f6805ac 100644 --- a/contributing.md +++ b/contributing.md @@ -53,12 +53,9 @@ that you can click on to open them. - What is the code supposed to do (optional) - Implementation details (if applicable) - Header files (.h) contain the following types of comments: - - Usage documentation (required) + -
Usage documentation (required) > [!NOTE] > Constructors/destructors aren't required to have a `\brief` description - - Implementation details (if they affect the header) - - Design/data structure decisions (if applicable) --
Comments are placed *above* the line(s) they are explaining
GoodBad
-- cgit v1.2.3