Skip to content

Commit cbbbc84

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

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
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}

doc/odoc_for_authors.mld

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,13 +392,14 @@ The prefixes supported are:
392392
- [instance-variable]
393393
- [section] (and the equivalent deprecated prefix [label]) - for referring to headings
394394
- [page] - for referring to [.mld] pages
395+
- [asset] - for referring to assets
395396

396397
In some cases the element being referenced might have a hyphen, a dot or a space in the name,
397398
e.g. if trying to refer to a page from a [.mld] file "1.2.3.mld". In this case, the
398399
element name should be quoted with double quote marks:
399400

400401
{v
401-
{!page-"1.2.3"}
402+
{!page-"1.2.3"}, {!asset-"file.txt"}
402403
v}
403404

404405

0 commit comments

Comments
 (0)