[commit: haddock] T6018-injective-type-families, adamse-D1033, ghc-head, master, wip/10268, wip/10313, wip/D538-3, wip/D538-4, wip/D538-5, wip/D538-6, wip/D548-master, wip/D548-master-2, wip/T10483, wip/T9840, wip/api-annot-tweaks-7.10, wip/api-annots-ghc-7.10-3, wip/orf-reboot: Update docs for @since (60ccf50)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/haddock

On branches: T6018-injective-type-families,adamse-D1033,ghc-head,master,wip/10268,wip/10313,wip/D538-3,wip/D538-4,wip/D538-5,wip/D538-6,wip/D548-master,wip/D548-master-2,wip/T10483,wip/T9840,wip/api-annot-tweaks-7.10,wip/api-annots-ghc-7.10-3,wip/orf-reboot
Link       : http://git.haskell.org/haddock.git/commitdiff/60ccf50433d823f18ee63e9c25c979e7b81f2fc1

>---------------------------------------------------------------

commit 60ccf50433d823f18ee63e9c25c979e7b81f2fc1
Author: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>
Date:   Thu Dec 18 07:30:58 2014 +0000

    Update docs for @since


>---------------------------------------------------------------

60ccf50433d823f18ee63e9c25c979e7b81f2fc1
 doc/haddock.xml | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/doc/haddock.xml b/doc/haddock.xml
index 3b58f82..2ffd7d7 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/>