From f11e9498c83d4b27ffc1029f6dbd7ef871953aca Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Fri, 3 May 2013 14:31:11 +0200 Subject: HACKING: Document the @since Doxygen tag. --- HACKING | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'HACKING') diff --git a/HACKING b/HACKING index dc4d53d..82176e1 100644 --- 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 --------------------------- -- cgit v1.2.3-70-g09d2