jon.recoil.org / odoc
this repo has no description
fork atom

Doc: update doc for tags

authored by

Paul-Elliot and committed by jon.recoil.org 47a67721 11c57e6e

+4 -4
unified split
+1
doc/ocamldoc_differences.mld
··· 15 15 - Heading levels are more restrictive. In the manual, it suggests any whole number is acceptable. In [odoc], 16 16 similarly to the HTML spec, we allow headings from 1-5. Heading level [0] is for the title 17 17 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. 18 19 19 20 {3 Omissions} 20 21 - Comments describing class inheritance are not rendered ({{:https://github.com/ocaml/odoc/issues/574}GitHub issue}).
+3 -4
doc/odoc_for_authors.mld
··· 485 485 {2:tags Tags} 486 486 487 487 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. 490 489 They should appear on their own lines with nothing but whitespace before them. 491 490 492 491 There are three types of tags. Those with: ··· 522 521 {3 Block Tags} 523 522 524 523 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. 527 526 528 527 - [@deprecated <text>] - marks the element as deprecated. [text] should describe 529 528 when the element was deprecated, what to use as a replacement, and possibly