Doxygen: Mark non-public stuff for exclusion.

[libsigrok.git] / HACKING

diff --git a/HACKING b/HACKING
index cd7e26556d010ec6034e2c45fcecf9c2f79ca9f7..d89f4a32b8ec1a70a8987e1c2021f8c3a57dd322 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -71,10 +71,22 @@ Random notes
    should end with "_all", e.g. "_remove_all", "_get_all", and so on.
    Use "_remove_all" in favor of "_clear" for consistency.
 
+
+Doxygen
+-------
+
  - In Doxygen comments, put an empty line between the block of @param lines
    and the final @return line. The @param lines themselves (if there is more
    than one) are not separated by empty lines.
 
+ - 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.
+
+ - Mark private variables/#defines with /** @cond PRIVATE */ and
+   /** @endcond */, so that Doxygen doesn't include them in the output.
+   Variables that are "static" don't need to be marked like this.
+
 
 Release engineering
 -------------------