module Cam_doc_gui: sig
.. end
Gui for documentation browser.
val modules_window : (GWindow.window * string GList.clist * GEdit.combo * Odoc_info.Name.t list)
option Pervasives.ref
The window with the list of available modules.
val create_or_update_list_window : Odoc_info.Module.t_module list Pervasives.ref -> unit
Create or update the box with the list of available top modules.
val search_elements_by_exact_names : Odoc_info.Module.t_module list Pervasives.ref -> string -> unit
This function search in loaded modules for the elements with the
given exact name. If only one element is found, it is displayed
in a textdoc. If more than one element
are found, a box is displayed with the list. If no element is found,
a message box is displayed.
val search_exact : Odoc_info.Module.t_module list Pervasives.ref -> unit
Make the user type a string and look in the given modules
for the elements with that name exactly.
val search_regexp : Odoc_info.Module.t_module list Pervasives.ref -> unit
Make the user type a regexp and look in the given modules
for the elements with that name exactly. If only one element
is found, it is displayed in a textdoc. If more than one element
are found, a box is displayed with the list. If no element is found,
a message box is displayed.
val update_module_box_if_displayed : Odoc_info.Module.t_module list Pervasives.ref -> unit
Function to call to update the module box, if it is displayed.
val open_element : Odoc_info.Module.t_module list Pervasives.ref -> Cam_doc.element -> unit
val show_odoc_info_and_code : title:string -> info:Odoc_info.info -> code:string -> unit