From: Peter van Dijk Date: Fri, 5 Nov 2021 15:03:32 +0000 (+0100) Subject: better docblock note X-Git-Tag: dnsdist-1.7.0-beta1~8^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d8e7225363232c4562d1494fa4994dfe13ba9f02;p=thirdparty%2Fpdns.git better docblock note --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f657d7290..1715b62423 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,5 +84,5 @@ Additional guidelines: * Don't have end-of-line whitespace * Use spaces instead of tabs -* Functions and classes must have a [docblock](http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html) +* Although the codebase does not consistently have them, [docblock](https://www.doxygen.nl/manual/docblocks.html)s on functions and classes are appreciated * Never hesitate to write comments on anything that might not be immediately clear just from reading the code