Skip to content

Commit c87f9eb

Browse files
committed
Assets: add documentation
Signed-off-by: Paul-Elliot <[email protected]>
1 parent 68f572d commit c87f9eb

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]
@@ -56,6 +57,7 @@ Additionally we support extra annotations:
5657
- [instance-variable] refers to instance variables
5758
- [label] refers to labels introduced in anchors
5859
- [page] refers to [.mld] pages as outlined above
60+
- [asset] refers assets as outlined above
5961
- [value] is recognised as [val]
6062

6163
{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
@@ -393,13 +393,14 @@ The prefixes supported are:
393393
- [instance-variable]
394394
- [section] (and the equivalent deprecated prefix [label]) - for referring to headings
395395
- [page] - for referring to [.mld] pages
396+
- [asset] - for referring to assets
396397

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

401402
{v
402-
{!page-"1.2.3"}
403+
{!page-"1.2.3"}, {!asset-"file.txt"}
403404
v}
404405

405406

0 commit comments

Comments
 (0)