Skip to content

Commit 47a6772

Browse files
panglesdjonludlam
authored andcommitted
Doc: update doc for tags
1 parent 11c57e6 commit 47a6772

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/ocamldoc_differences.mld

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ The following describes the changes between what [odoc] understands and what’s
1515
- Heading levels are more restrictive. In the manual, it suggests any whole number is acceptable. In [odoc],
1616
similarly to the HTML spec, we allow headings from 1-5. Heading level [0] is for the title
1717
of [.mld] files. [odoc] emits a warning for heading levels outside this range and caps them.
18+
- Tags are restricted in scope and do not need to be put at the end of the docstring.
1819

1920
{3 Omissions}
2021
- Comments describing class inheritance are not rendered ({{:https://github.com/ocaml/odoc/issues/574}GitHub issue}).

doc/odoc_for_authors.mld

+3-4
Original file line numberDiff line numberDiff line change
@@ -485,8 +485,7 @@ the {{!page-driver}driver}.
485485
{2:tags Tags}
486486

487487
Tags are used to provide specific information for individual elements, such
488-
as author, version, parameters, etc. Tags start with an [@] symbol, appear
489-
at the end of documentation comments, and are not allowed elsewhere.
488+
as author, version, parameters, etc. Tags start with an [@] symbol.
490489
They should appear on their own lines with nothing but whitespace before them.
491490

492491
There are three types of tags. Those with:
@@ -522,8 +521,8 @@ i.e., there shouldn't be any [odoc] markup.
522521
{3 Block Tags}
523522

524523
These tags have a block of potentially marked-up text associated with them,
525-
and occasionally some more data too. The block of text concludes with the end
526-
of the comment or by another tag. They are:
524+
and occasionally some more data too. The block of text is implicitely ended by a
525+
new line, a heading or another tag.
527526

528527
- [@deprecated <text>] - marks the element as deprecated. [text] should describe
529528
when the element was deprecated, what to use as a replacement, and possibly

0 commit comments

Comments
 (0)