Skip to content

Commit

Permalink
Assets: add documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Paul-Elliot <[email protected]>
  • Loading branch information
panglesd committed Sep 28, 2023
1 parent 0eac1f4 commit cbbbc84
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 2 additions & 0 deletions doc/ocamldoc_differences.mld
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ The following describes the changes between what [odoc] understands and what’s
- [odoc] has a better mechanism for disambiguating references in comments. See 'reference syntax' later in this document.
- Built-in support for standalone [.mld] files. These are documents using the OCamldoc markup, but they’re rendered as distinct pages.
- Structured output: [odoc] can produce output in a structured directory tree rather a set of files.
- [odoc] support the inclusion of assets in the structured directory tree.
- A few extra tags are supported:
+ [@returns] is a synonym for [@return]
+ [@raises] is a synonym for [@raise]
Expand All @@ -55,6 +56,7 @@ Additionally we support extra annotations:
- [instance-variable] refers to instance variables
- [label] refers to labels introduced in anchors
- [page] refers to [.mld] pages as outlined above
- [asset] refers assets as outlined above
- [value] is recognised as [val]

{3 Referencing items containing hyphens or dots}
Expand Down
3 changes: 2 additions & 1 deletion doc/odoc_for_authors.mld
Original file line number Diff line number Diff line change
Expand Up @@ -392,13 +392,14 @@ The prefixes supported are:
- [instance-variable]
- [section] (and the equivalent deprecated prefix [label]) - for referring to headings
- [page] - for referring to [.mld] pages
- [asset] - for referring to assets

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

{v
{!page-"1.2.3"}
{!page-"1.2.3"}, {!asset-"file.txt"}
v}


Expand Down

0 comments on commit cbbbc84

Please sign in to comment.