From: Uwe Hermann <redacted>
Date: Sat, 9 Feb 2013 20:43:46 +0000 (+0100)
Subject: Doxygen: Document how to mark private stuff.
X-Git-Tag: libsigrokdecode-0.2.0~23
X-Git-Url: http://sigrok.org/gitweb/?a=commitdiff_plain;h=31e615a50b34f67bdf5562ad887415b2ec8796c8;p=libsigrokdecode.git

Doxygen: Document how to mark private stuff.
---

diff --git a/HACKING b/HACKING
index 922415f..dc4d53d 100644
--- a/HACKING
+++ b/HACKING
@@ -74,10 +74,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 (SRD_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.
+
 
 Protocol decoder guidelines
 ---------------------------