module OcamldocUtils: sig
.. end
Utility functions related to the ocamldoc library.
val line_and_column_of_location : Location.t option -> int * int option
Converts the passed (file, offset)
pair into a (line, column)
pair.
Returns some dummy value is either None
is passed, or an i/o error
occurs while trying to read data from file
.
val string_of_text_element : Odoc_info.text_element -> string
Converts the passed text element into a bare string, with no formatting.
val string_of_text : Odoc_info.text -> string
Converts the passed text into a bare string, with no formatting.
val string_of_text_option : Odoc_info.text option -> string
Converts the passed text option into a bare string, with no formatting.
val string_of_text_list : Odoc_info.text list -> string
Converts the passed text list into a bare string, with no formatting.
val string_of_info : Odoc_info.info -> string
Converts the passed info into a bare string, with no formatting.
val string_of_info_option : Odoc_info.info option -> string
Converts the passed info option into a bare string, with no formatting.
val is_empty_info_option : bool -> Odoc_info.info option -> bool
Tests whether the passed info option is empty, the passed boolean
indicating if the test is strict. When strict, either None
, or
Some s
where s
containing only whitespaces will return true
.
When non-strict, any Some s
value will return true.