Add doc-comment for the implementation module

Signed-off-by: Paul-Elliot <[email protected]> Co-authored-by: Jules Aguillon <[email protected]>
ocaml · Aug 30, 2023 · 8073c59 · 8073c59
1 parent 1d1e249
commit 8073c59
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/loader/implementation.mli b/src/loader/implementation.mli
@@ -3,3 +3,7 @@ val of_cmt :
   Odoc_model.Paths.Identifier.RootModule.t ->
   Cmt_format.cmt_infos ->
   Shape_.t option * Odoc_model.Lang.Source_info.infos
+(** Extract all implementation information from a [cmt]: the shape, and the
+    {{!Odoc_model.Lang.Source_info.infos}source infos}.
+
+    In OCaml version below 4.14, the information is always empty. *)