Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
H
haddock
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Stephen Judkins
haddock
Commits
60ccf504
Commit
60ccf504
authored
10 years ago
by
Mateusz Kowalczyk
Browse files
Options
Downloads
Patches
Plain Diff
Update docs for @since
parent
15f10811
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/haddock.xml
+34
-0
34 additions, 0 deletions
doc/haddock.xml
with
34 additions
and
0 deletions
doc/haddock.xml
+
34
−
0
View file @
60ccf504
...
...
@@ -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/>
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment