File tree Expand file tree Collapse file tree 2 files changed +4
-1
lines changed Expand file tree Collapse file tree 2 files changed +4
-1
lines changed Original file line number Diff line number Diff line change @@ -33,6 +33,7 @@ The following describes the changes between what [odoc] understands and what’s
33
33
- [odoc] has a better mechanism for disambiguating references in comments. See 'reference syntax' later in this document.
34
34
- Built-in support for standalone [.mld] files. These are documents using the OCamldoc markup, but they’re rendered as distinct pages.
35
35
- Structured output: [odoc] can produce output in a structured directory tree rather a set of files.
36
+ - [odoc] support the inclusion of assets in the structured directory tree.
36
37
- A few extra tags are supported:
37
38
+ [@returns] is a synonym for [@return]
38
39
+ [@raises] is a synonym for [@raise]
@@ -55,6 +56,7 @@ Additionally we support extra annotations:
55
56
- [instance-variable] refers to instance variables
56
57
- [label] refers to labels introduced in anchors
57
58
- [page] refers to [.mld] pages as outlined above
59
+ - [asset] refers assets as outlined above
58
60
- [value] is recognised as [val]
59
61
60
62
{3 Referencing items containing hyphens or dots}
Original file line number Diff line number Diff line change @@ -392,13 +392,14 @@ The prefixes supported are:
392
392
- [instance-variable]
393
393
- [section] (and the equivalent deprecated prefix [label]) - for referring to headings
394
394
- [page] - for referring to [.mld] pages
395
+ - [asset] - for referring to assets
395
396
396
397
In some cases the element being referenced might have a hyphen, a dot or a space in the name,
397
398
e.g. if trying to refer to a page from a [.mld] file "1.2.3.mld". In this case, the
398
399
element name should be quoted with double quote marks:
399
400
400
401
{v
401
- {!page-"1.2.3"}
402
+ {!page-"1.2.3"}, {!asset-"file.txt"}
402
403
v}
403
404
404
405
You can’t perform that action at this time.
0 commit comments