ocaml-base-compiler
  1. Overview
  2. Docs
package ocaml-base-compiler
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ref_kind =
  1. | RK_module
  2. | RK_module_type
  3. | RK_class
  4. | RK_class_type
  5. | RK_value
  6. | RK_type
  7. | RK_extension
  8. | RK_exception
  9. | RK_attribute
  10. | RK_method
  11. | RK_section of text
  12. | RK_recfield
  13. | RK_const
and text_element =
  1. | Raw of string
  2. | Code of string
  3. | CodePre of string
  4. | Verbatim of string
  5. | Bold of text
  6. | Italic of text
  7. | Emphasize of text
  8. | Center of text
  9. | Left of text
  10. | Right of text
  11. | List of text list
  12. | Enum of text list
  13. | Newline
  14. | Block of text
  15. | Title of int * string option * text
  16. | Latex of string
  17. | Link of string * text
  18. | Ref of string * ref_kind option * text option
  19. | Superscript of text
  20. | Subscript of text
  21. | Module_list of string list
  22. | Index_list
  23. | Custom of string * text
  24. | Target of string * string
and text = text_element list
type see_ref =
  1. | See_url of string
  2. | See_file of string
  3. | See_doc of string
type see = see_ref * text
type param = string * text
type raised_exception = string * text
type info = {
  1. i_desc : text option;
  2. i_authors : string list;
  3. i_version : string option;
  4. i_sees : see list;
  5. i_since : string option;
  6. i_before : (string * text) list;
  7. i_deprecated : text option;
  8. i_params : param list;
  9. i_raised_exceptions : raised_exception list;
  10. i_return_value : text option;
  11. i_custom : (string * text) list;
}
val dummy_info : info
type location = {
  1. loc_impl : Location.t option;
  2. loc_inter : Location.t option;
}
val dummy_loc : location
type merge_option =
  1. | Merge_description
  2. | Merge_author
  3. | Merge_version
  4. | Merge_see
  5. | Merge_since
  6. | Merge_before
  7. | Merge_deprecated
  8. | Merge_param
  9. | Merge_raised_exception
  10. | Merge_return_value
  11. | Merge_custom
val all_merge_options : merge_option list
type magic
val magic : magic
type 'a dump
val make_dump : 'a -> 'a dump
val open_dump : 'a dump -> 'a