Module `Component.Fmt`Source

Formatting functions for components

Sourcetype config = {

short_paths : bool;
show_canonical : bool;
show_removed : bool;
show_expansions : bool;
show_include_expansions : bool;

}

Sourceval default : Odoc_xref2.Component.Fmt.config

val signature : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Signature.t ->
  unit

Source

val removed_item : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Signature.removed_item ->
  unit

Source

val removed_item_list : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Signature.removed_item list ->
  unit

Source

val class_ : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Class.t ->
  unit

Source

val class_type : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.ClassType.t ->
  unit

Source

val include_ : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Include.t ->
  unit

Source

val value : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Value.t ->
  unit

Source

val module_decl : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Module.decl ->
  unit

Source

val include_decl : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Include.decl ->
  unit

Source

val module_ : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Module.t ->
  unit

Source

val module_type : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.ModuleType.t ->
  unit

Source

val simple_expansion : 
  Odoc_xref2.Component.Fmt.config ->
  bool ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.ModuleType.simple_expansion ->
  unit

Source

val module_type_type_of_desc : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.ModuleType.type_of_desc ->
  unit

Source

val u_module_type_expr : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.ModuleType.U.expr ->
  unit

Source

val module_type_expr : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.ModuleType.expr ->
  unit

Source

val functor_parameter : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.FunctorParameter.t ->
  unit

Source

val functor_parameter_parameter : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.FunctorParameter.parameter ->
  unit

Source

val type_decl : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.TypeDecl.t ->
  unit

Source

val type_equation : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.TypeDecl.Equation.t ->
  unit

Source

val exception_ : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Exception.t ->
  unit

Source

val extension : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.Extension.t ->
  unit

Source

val substitution : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.ModuleType.substitution ->
  unit

Source

val substitution_list : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.ModuleType.substitution list ->
  unit

Source

val type_expr_list : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.TypeExpr.t list ->
  unit

Source

val type_object : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.TypeExpr.Object.t ->
  unit

Source

val type_class : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  (Odoc_xref2.Cpath.class_type * Odoc_xref2.Component.TypeExpr.t list) ->
  unit

Source

val type_package : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.TypeExpr.Package.t ->
  unit

Source

val type_expr_polymorphic_variant : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.TypeExpr.Polymorphic_variant.t ->
  unit

Source

val type_expr : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Component.TypeExpr.t ->
  unit

Source

val resolved_module_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.Resolved.module_ ->
  unit

Source

val module_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.module_ ->
  unit

Source

val resolved_module_type_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.Resolved.module_type ->
  unit

Source

val module_type_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.module_type ->
  unit

Source

val resolved_type_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.Resolved.type_ ->
  unit

Source

val resolved_value_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.Resolved.value ->
  unit

Source

val resolved_parent_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.Resolved.parent ->
  unit

Source

val type_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.type_ ->
  unit

Source

val value_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.value ->
  unit

Source

val resolved_class_type_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.Resolved.class_type ->
  unit

Source

val class_type_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cpath.class_type ->
  unit

Source

val model_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_model.Paths.Path.t ->
  unit

Source

val model_resolved_path : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_model.Paths.Path.Resolved.t ->
  unit

Source

val model_identifier : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_model.Paths.Identifier.t ->
  unit

Source

val model_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_model.Paths.Fragment.t ->
  unit

Source

val model_resolved_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_model.Paths.Fragment.Resolved.t ->
  unit

Source

val resolved_root_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cfrag.root ->
  unit

Source

val resolved_signature_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cfrag.resolved_signature ->
  unit

Source

val resolved_module_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cfrag.resolved_module ->
  unit

Source

val resolved_type_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cfrag.resolved_type ->
  unit

Source

val signature_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cfrag.signature ->
  unit

Source

val module_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cfrag.module_ ->
  unit

Source

val module_type_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cfrag.module_type ->
  unit

Source

val type_fragment : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_xref2.Cfrag.type_ ->
  unit

Source

val model_resolved_reference : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_model.Paths.Reference.Resolved.t ->
  unit

Source

val model_reference : 
  Odoc_xref2.Component.Fmt.config ->
  Stdlib.Format.formatter ->
  Odoc_model.Paths.Reference.t ->
  unit

Module Component.FmtSource

Module `Component.Fmt`Source