From 4f953a35912c3d92c26bcb6c2cc77cc3ced176a3 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 6 Nov 2024 13:27:52 +0100 Subject: update contributing.md --- contributing.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/contributing.md b/contributing.md index 8ed3b80..88cba32 100644 --- a/contributing.md +++ b/contributing.md @@ -54,6 +54,9 @@ that you can click on to open them. - Implementation details (if applicable) - Header files (.h) contain the following types of comments: - 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) -
-- cgit v1.2.3