HACKING: Document the @since Doxygen tag.
authorUwe Hermann <uwe@hermann-uwe.de>
Fri, 3 May 2013 12:31:11 +0000 (14:31 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Fri, 3 May 2013 18:36:28 +0000 (20:36 +0200)
HACKING

diff --git a/HACKING b/HACKING
index dc4d53d45b37592eda9d750e8e585156d5e9fcf3..82176e14c216b295d0e7cc46da250ce21ec410bb 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -90,6 +90,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 (SRD_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 SRD_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)
+
 
 Protocol decoder guidelines
 ---------------------------