X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=HACKING;h=9d71c55c11d0fa240b7eb3b5f32b83e0b20a095c;hp=a5aa8d6654bd130be98df0ad7bb29901fdd01e4a;hb=e972674d0b30b98dcc354b707a80b6bfc1aeb532;hpb=18037e79f1dba7342dc28595d0ac3e5d5ad922ac

diff --git a/HACKING b/HACKING
index a5aa8d66..9d71c55c 100644
--- a/HACKING
+++ b/HACKING
@@ -164,7 +164,9 @@ Doxygen
 
  - Mark private functions (SR_PRIV) with /** @private */, so that Doxygen
    doesn't include them in the output. Functions that are "static" anyway
-   don't need to be marked like this.
+   don't need to be marked like this. Functions in non-public files that
+   are explicitly excluded in Doxyfile don't need to be marked either.
+   Don't use @internal, always use @private instead.
 
  - Mark private variables/#defines with /** @cond PRIVATE */ and
    /** @endcond */, so that Doxygen doesn't include them in the output.