Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.

Write documentation for ocamldoc comment header syntax #172

Open
ryyppy opened this issue Apr 28, 2020 · 0 comments
Open

Write documentation for ocamldoc comment header syntax #172

ryyppy opened this issue Apr 28, 2020 · 0 comments
Labels
docs Technical writing good first issue Good for newcomers

Comments

@ryyppy
Copy link
Member

ryyppy commented 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:

@ryyppy ryyppy changed the title Document the doc header syntax for generating API documentation Write documentation for ocamldoc comment header syntax Apr 28, 2020
@ryyppy ryyppy added docs Technical writing good first issue Good for newcomers labels Apr 28, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Technical writing good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant