module Annotation: sig
.. end
Definition annotation file contents.
type
error =
| |
Empty_line |
| |
Invalid_block_start of string |
| |
Invalid_annotation of string |
| |
Invalid_reference_kind of string |
exception Exception of error
Exception to be raised when a function of this module fails.
type
call =
The kind of function calls.
type
ident =
| |
Definition |
| |
Internal_reference |
| |
External_reference |
The kind of identifier uses.
type
t =
| |
Type of string |
| |
Call of call |
| |
Ident of ident * string |
The kind of annotations.
type
position = {
|
filename : string ; |
|
line : int ; |
|
line_offset : int ; |
|
offset : int ; |
}
The type of file positions.
type
block = {
}
The type of blocks, that is a range and associated elements.
type
file = block list
The type representing the contents of a whole file.
val load_file : string -> file
Loads annotations from passed file, raising Exception
if the file does
not respect the format of annotations.
Raises Sys_error
if the file does not exist.