package doc-ock

  1. Overview
  2. Docs
package doc-ock
Legend:
Library
Module
Module type
Parameter
Class
Class type
type style =
  1. | Bold
  2. | Italic
  3. | Emphasize
  4. | Center
  5. | Left
  6. | Right
  7. | Superscript
  8. | Subscript
  9. | Custom of string
type 'a reference =
  1. | Element of 'a DocOckPaths.Reference.any
  2. | Custom of string * string
type see =
  1. | Url of string
  2. | File of string
  3. | Doc of string
type 'a text = 'a text_element list
and 'a text_element =
  1. | Raw of string
  2. | Code of string
  3. | PreCode of string
  4. | Verbatim of string
  5. | Style of style * 'a text
  6. | List of 'a text list
  7. | Enum of 'a text list
  8. | Newline
  9. | Title of int * 'a DocOckPaths.Identifier.label option * 'a text
  10. | Reference of 'a reference * 'a text option
  11. | Target of string option * string
  12. | Special of 'a special
and 'a tag =
  1. | Author of string
  2. | Version of string
  3. | See of see * 'a text
  4. | Since of string
  5. | Before of string * 'a text
  6. | Deprecated of 'a text
  7. | Param of string * 'a text
  8. | Raise of string * 'a text
  9. | Return of 'a text
  10. | Inline
  11. | Tag of string * 'a text
  12. | Canonical of 'a DocOckPaths.Path.module_ * 'a DocOckPaths.Reference.module_
and 'a special =
  1. | Modules of ('a DocOckPaths.Reference.module_ * 'a text) list
  2. | Index
module Error : sig ... end
type 'a body = {
  1. text : 'a text;
  2. tags : 'a tag list;
}
type 'a t =
  1. | Ok of 'a body
  2. | Error of 'a Error.t
type 'a comment =
  1. | Documentation of 'a t
  2. | Stop