Skip to content

Commit f479436

Browse files
committed
Assets: add documentation
Signed-off-by: Paul-Elliot <[email protected]>
1 parent 0eac1f4 commit f479436

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

doc/ocamldoc_differences.mld

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The following describes the changes between what [odoc] understands and what’s
3333
- [odoc] has a better mechanism for disambiguating references in comments. See 'reference syntax' later in this document.
3434
- Built-in support for standalone [.mld] files. These are documents using the OCamldoc markup, but they’re rendered as distinct pages.
3535
- 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.
3637
- A few extra tags are supported:
3738
+ [@returns] is a synonym for [@return]
3839
+ [@raises] is a synonym for [@raise]
@@ -55,6 +56,7 @@ Additionally we support extra annotations:
5556
- [instance-variable] refers to instance variables
5657
- [label] refers to labels introduced in anchors
5758
- [page] refers to [.mld] pages as outlined above
59+
- [asset] refers assets as outlined above
5860
- [value] is recognised as [val]
5961

6062
{3 Referencing items containing hyphens or dots}

0 commit comments

Comments
 (0)