Module `Odoc_model.Semantics`Source

Sourcetype _ handle_internal_tags =

| Expect_status : [ `Default | `Inline | `Open | `Closed ] Odoc_model.Semantics.handle_internal_tags
| Expect_canonical : Odoc_model.Reference.path option Odoc_model.Semantics.handle_internal_tags
| Expect_none : unit Odoc_model.Semantics.handle_internal_tags
| Expect_page_tags : Odoc_model.Frontmatter.t Odoc_model.Semantics.handle_internal_tags

How to handle internal tags.

Sourcetype sections_allowed = [

| `All
| `No_titles
| `None

]

type alerts =
  [ `Tag of [ `Alert of string * string option ] ]
    Odoc_model.Location_.with_location
    list

Source

val ast_to_comment : 
  internal_tags:'tags Odoc_model.Semantics.handle_internal_tags ->
  tags_allowed:bool ->
  parent_of_sections:Odoc_model.Paths.Identifier.LabelParent.t ->
  Odoc_parser.Ast.t ->
  Odoc_model.Semantics.alerts ->
  (Odoc_model.Comment.elements * 'tags) Odoc_model.Error.with_warnings

Source

val non_link_inline_element : 
  context:string ->
  Odoc_parser.Ast.inline_element Odoc_model.Location_.with_location list ->
  Odoc_model.Comment.non_link_inline_element Odoc_model.Location_.with_location
    list

Source

val parse_comment : 
  internal_tags:'tags Odoc_model.Semantics.handle_internal_tags ->
  tags_allowed:bool ->
  containing_definition:Odoc_model.Paths.Identifier.LabelParent.t ->
  location:Stdlib.Lexing.position ->
  text:string ->
  (Odoc_model.Comment.elements * 'tags) Odoc_model.Error.with_warnings

Source

val parse_reference : 
  string ->
  Odoc_model.Paths.Reference.t Odoc_model.Error.with_errors_and_warnings

Module Odoc_model.SemanticsSource

Module `Odoc_model.Semantics`Source