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]
@@ -56,6 +57,7 @@ Additionally we support extra annotations:
56
57
- [instance-variable] refers to instance variables
57
58
- [label] refers to labels introduced in anchors
58
59
- [page] refers to [.mld] pages as outlined above
60
+ - [asset] refers assets as outlined above
59
61
- [value] is recognised as [val]
60
62
61
63
{3 Referencing items containing hyphens or dots}
Original file line number Diff line number Diff line change @@ -393,13 +393,14 @@ The prefixes supported are:
393
393
- [instance-variable]
394
394
- [section] (and the equivalent deprecated prefix [label]) - for referring to headings
395
395
- [page] - for referring to [.mld] pages
396
+ - [asset] - for referring to assets
396
397
397
398
In some cases the element being referenced might have a hyphen, a dot or a space in the name,
398
399
e.g. if trying to refer to a page from a [.mld] file "1.2.3.mld". In this case, the
399
400
element name should be quoted with double quote marks:
400
401
401
402
{v
402
- {!page-"1.2.3"}
403
+ {!page-"1.2.3"}, {!asset-"file.txt"}
403
404
v}
404
405
405
406
You can’t perform that action at this time.
0 commit comments