ocaml-docs

Fix odoc warnings during a dune build by correcting odoc reference syntax and disambiguation. This process resolves cross-package references, hidden fields, and @raise tag issues to ensure precise OCaml documentation generation.

OCaml cross-package references fail in odoc due to incorrect reference syntax or missing exports. Resolving these odoc warnings requires fixing ambiguous references and ensuring external dependencies link correctly across modules and libraries.

You need pinned versions of dune using odoc-v3 rules and a staging version of odoc to validate OCaml documentation syntax. These prerequisites reliably parse and validate documentation references and syntax.

The correct way to use the @raise tag in OCaml documentation is to point to the right exceptions. Adjusting the odoc reference syntax ensures the @raise tag properly resolves to the intended exception definitions.

The best way to eliminate odoc errors across modules and libraries is running dune build @doc and applying guided fixes. This addresses reference syntax, cross-package links, and hidden fields to clean up documentation warnings.