From 8073c5916403045f268aedc9909d1acf4f320413 Mon Sep 17 00:00:00 2001 From: Paul-Elliot Date: Wed, 30 Aug 2023 15:28:16 +0200 Subject: [PATCH] Add doc-comment for the implementation module Signed-off-by: Paul-Elliot Co-authored-by: Jules Aguillon --- src/loader/implementation.mli | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/loader/implementation.mli b/src/loader/implementation.mli index 8d88d0e345..85f4b170c1 100644 --- 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. *)