You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.
In Reason, doc headers need to be written in ocamldoc syntax.
You can find the specification of the ocamldoc format in the OCaml Manual here
Ideally, we'd extract the most relevant information and describe the syntax in Reason snippets, so it's easy to copy and paste them. Maybe give some pointers on best practises ("Comments are usually put into .rei files, if existent").
Infrastructure related information (odoc, ocamldoc, building etc.) can be left out for now.
The text was updated successfully, but these errors were encountered:
ryyppy
changed the title
Document the doc header syntax for generating API documentation
Write documentation for ocamldoc comment header syntax
Apr 28, 2020
In Reason, doc headers need to be written in
ocamldoc
syntax.You can find the specification of the ocamldoc format in the OCaml Manual here
Ideally, we'd extract the most relevant information and describe the syntax in Reason snippets, so it's easy to copy and paste them. Maybe give some pointers on best practises ("Comments are usually put into .rei files, if existent").
Infrastructure related information (odoc, ocamldoc, building etc.) can be left out for now.
Useful resources:
The text was updated successfully, but these errors were encountered: