Doxygen: Add @since markers.

[libsigrok.git] / HACKING

diff --git a/HACKING b/HACKING
index faac0a8c0da22a4bcf900efa8ccddb87f2703a20..cf407c985d95fa3c4b8ef0992a8da1a7af99d39a 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -143,6 +143,22 @@ Doxygen
    /** @endcond */, so that Doxygen doesn't include them in the output.
    Variables that are "static" don't need to be marked like this.
 
+ - Mark all public API functions (SR_API) with a @since tag which indicates
+   in which release the respective function was added. If the function has
+   existed before, but its API changed later, document this as well.
+
+   Non-public functions (static ones, and those marked SR_PRIV) don't need
+   to have @since markers.
+
+   The @since tag should be the last one, i.e. it should come after @param,
+   @return, @see, and so on.
+
+   Examples:
+
+     @since 0.1.0
+
+     @since 0.1.1 (but the API changed in 0.2.0)
+
 
 Testsuite
 ---------