Up – Package index » The odoc documentation generator » Library odoc.xref_test » Odoc_xref_test » Common

Module `Odoc_xref_test.Common`Source

The odoc documentation generator
- odoc for Authors
- Cheatsheet
- Dune and odoc
- Language Features
- Markup Differences From OCamldoc
- odoc Interface Guarantees
- How to Drive odoc
- JSON output
- Deprecated features
- Library odoc.document
  - Odoc_document
- Library odoc.examples
  - Odoc_examples
- Library odoc.html
  - Odoc_html
- Library odoc.html_support_files
  - Odoc_html_support_files
- Library odoc.index
  - Odoc_index
- Library odoc.json_index
  - Odoc_json_index
- Library odoc.latex
  - Odoc_latex
- Library odoc.loader
  - Odoc_loader
- Library odoc.manpage
  - Odoc_manpage
- Library odoc.model
  - Odoc_model
- Library odoc.model_desc
  - Odoc_model_desc
- Library odoc.ocamlary
  - Ocamlary
- Library odoc.occurrences
  - Odoc_occurrences
- Library odoc.odoc
  - Odoc_odoc
- Library odoc.odoc_utils
  - Odoc_utils
- Library odoc.search
  - Odoc_search
- Library odoc.search_html_frontend
  - Odoc_html_frontend
- Library odoc.syntax_highlighter
  - Syntax_highlighter
- Library odoc.xref2
  - Odoc_xref2
- Library odoc.xref_test
  - Odoc_xref_test
    - Common
      - Ident
      - LangUtils
- Sources

Sourceval cmti_of_string : string -> Typedtree.signature

Sourceval cmt_of_string : string -> Typedtree.implementation

val parent : 
  [> `Page of
       Odoc_model.Paths.Identifier.ContainerPage.t option
       * Odoc_model.Names.PageName.t ]
    Odoc_model.Paths.Identifier.id

val id : 
  [> `Root of
       Odoc_model.Paths.Identifier.ContainerPage.t option
       * Odoc_model.Names.ModuleName.t ]
    Odoc_model.Paths.Identifier.id

val root_of_compilation_unit : 
  package:'a ->
  hidden:bool ->
  module_name:string ->
  digest:Digest.t ->
  (Odoc_model.Root.t, 'b) Result.result

Sourceval root : Odoc_model.Root.t

val root_identifier : 
  [> `Identifier of
       [> `Root of
            Odoc_model.Paths.Identifier.ContainerPage.t option
            * Odoc_model.Names.ModuleName.t ]
         Odoc_model.Paths.Identifier.id ]

val root_module : 
  string ->
  [> `Module of
       Odoc_model.Paths.Identifier.Signature.t * Odoc_model.Names.ModuleName.t ]
    Odoc_model.Paths.Identifier.id

Sourceval root_pp : Format.formatter -> Odoc_model.Root.t -> unit

val model_of_string : 
  string ->
  Odoc_model.Paths.Identifier.RootModule.t
  * Odoc_model.Lang.Signature.t
  * Odoc_model.Paths.Path.Module.t option

val model_of_string_impl : 
  string ->
  Odoc_model.Paths.Identifier.RootModule.t
  * Odoc_model.Lang.Signature.t
  * Odoc_model.Paths.Path.Module.t option

Sourceval signature_of_mli_string : string -> Odoc_model.Lang.Signature.t

module Ident = Ident

Sourcemodule LangUtils : sig ... end

val my_compilation_unit : 
  Odoc_model.Paths.Identifier.RootModule.t ->
  Odoc_model.Lang.Signature.t ->
  Odoc_model.Lang.Compilation_unit.t

Sourceval mkresolver : unit -> Odoc_odoc.Resolver.t

Sourceval warnings_options : Odoc_model.Error.warnings_options

Sourceval handle_warnings : 'a Odoc_model.Error.with_warnings -> 'a

val resolve : 
  Odoc_model.Lang.Compilation_unit.t ->
  Odoc_model.Lang.Compilation_unit.t

Sourceval resolve_from_string : string -> Odoc_model.Lang.Compilation_unit.t

val compile_signature : 
  ?id:Odoc_model.Paths.Identifier.Signature.t_pv Odoc_model.Paths.Identifier.id ->
  Odoc_model.Lang.Signature.t ->
  Odoc_model.Lang.Signature.t

Sourceval compile_mli : string -> Odoc_model.Lang.Signature.t