Skip to content

Commit 35fe6a0

Browse files
panglesdJulow
authored andcommitted
Add doc-comment for the implementation module
Co-authored-by: Jules Aguillon <[email protected]> Signed-off-by: Paul-Elliot <[email protected]>
1 parent cfa75f5 commit 35fe6a0

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

src/loader/ident_env.cppo.mli

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,6 @@ val extract_signature_tree_items :
9494

9595
val identifier_of_loc :
9696
t -> Warnings.loc -> Odoc_model.Paths.Identifier.t option
97+
(** Each generated id has its location stored. This allows to get back the id
98+
knowing only the location. This is used to generate links to source from the
99+
resolution of a shape. *)

src/loader/implementation.mli

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,8 @@ val of_cmt :
33
Odoc_model.Paths.Identifier.RootModule.t ->
44
Cmt_format.cmt_infos ->
55
Shape_.t option * Odoc_model.Lang.Source_info.infos
6+
(** Extract all implementation information from a [cmt]: the shape, and the
7+
{{!Odoc_model.Lang.Source_info.infos}source infos} (local and global
8+
definitions and occurrences).
9+
10+
In OCaml version below 4.14, the information is always empty. *)

0 commit comments

Comments
 (0)