diff options
author | Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk> | 2014-12-18 07:30:58 +0000 |
---|---|---|
committer | Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk> | 2014-12-18 07:30:58 +0000 |
commit | 60ccf50433d823f18ee63e9c25c979e7b81f2fc1 (patch) | |
tree | dd5f469ac3864a9b6d1e50f0a135b01a089c94cb | |
parent | 15f10811226a761617a408943936b13ed2624b37 (diff) |
Update docs for @since
-rw-r--r-- | doc/haddock.xml | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml index 3b58f824..2ffd7d78 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -2210,6 +2210,40 @@ This belongs to the list above! </section> + <section> + <title>Metadata</title> + <para>Since Haddock 2.16.0, some support for embedding + metadata in the comments has started to appear. The use of + such data aims to standardise various community conventions in + how such information is conveyed and to provide uniform + rendering. + </para> + + <section> + <title>Since</title> + <para><literal>@since</literal> annotation can be used to + convey information about when the function was introduced or + when it has changed in the way significant to the user. + <literal>@since</literal> is a paragraph-level element. + While multiple such annotations are not an error, only the + one to appear in the comment last will be used. + <literal>@since</literal> has to be followed with a version + number, no further description is currently allowed. The + meaning of this feature is subject to change in the future + per user feedback. + </para> + +<programlisting> +-- | +-- Some comment +-- +-- @since 1.2.3 +</programlisting> + + </section> + + </section> + </section> </chapter> <index/> |