package odoc

  1. Overview
  2. Docs

Module Odoc_index.EntrySource

Sourcetype type_decl_entry = {
  1. canonical : Odoc_model.Paths.Path.Type.t option;
  2. equation : Odoc_model.Lang.TypeDecl.Equation.t;
  3. representation : Odoc_model.Lang.TypeDecl.Representation.t option;
}
Sourcetype class_type_entry = {
  1. virtual_ : bool;
  2. params : Odoc_model.Lang.TypeDecl.param list;
}
Sourcetype method_entry = {
  1. private_ : bool;
  2. virtual_ : bool;
  3. type_ : Odoc_model.Lang.TypeExpr.t;
}
Sourcetype class_entry = {
  1. virtual_ : bool;
  2. params : Odoc_model.Lang.TypeDecl.param list;
}
Sourcetype type_extension_entry = {
  1. type_path : Odoc_model.Paths.Path.Type.t;
  2. type_params : Odoc_model.Lang.TypeDecl.param list;
  3. private_ : bool;
}
Sourcetype constructor_entry = {
  1. args : Odoc_model.Lang.TypeDecl.Constructor.argument;
  2. res : Odoc_model.Lang.TypeExpr.t;
}
Sourcetype field_entry = {
  1. mutable_ : bool;
  2. type_ : Odoc_model.Lang.TypeExpr.t;
  3. parent_type : Odoc_model.Lang.TypeExpr.t;
}
Sourcetype instance_variable_entry = {
  1. mutable_ : bool;
  2. virtual_ : bool;
  3. type_ : Odoc_model.Lang.TypeExpr.t;
}
Sourcetype value_entry = {
  1. value : Odoc_model.Lang.Value.value;
  2. type_ : Odoc_model.Lang.TypeExpr.t;
}
Sourcetype module_entry = {
  1. has_expansion : bool;
}
Sourcetype kind =
  1. | TypeDecl of type_decl_entry
  2. | Module of module_entry
  3. | Value of value_entry
  4. | Doc
  5. | Exception of constructor_entry
  6. | Class_type of class_type_entry
  7. | Method of method_entry
  8. | Class of class_entry
  9. | TypeExtension of type_extension_entry
  10. | ExtensionConstructor of constructor_entry
  11. | ModuleType of module_entry
  12. | Constructor of constructor_entry
  13. | Field of field_entry
  14. | UnboxedField of field_entry
  15. | Page of Odoc_model.Frontmatter.t
  16. | Impl
  17. | Dir
Sourceval entry : id:[< Odoc_model.Paths.Identifier.Any.t_pv ] Odoc_model.Paths.Identifier.id -> doc:Odoc_model.Comment.elements -> kind:kind -> t