package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml documentation generator

Install

dune-project

Dependency

github.com Readme Changelog ISC License Edit opam file Versions (4)

Authors

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.document/Odoc_document/Url/Path/index.html

Module `Url.Path`

type kind = [

| `Module
| `Page
| `LeafPage
| `ModuleType
| `Argument
| `Class
| `ClassType
| `File

]

val pp_kind : Format.formatter -> kind -> unit

val string_of_kind : kind -> string

type t = {

kind : kind;
parent : t option;
name : string;

}

type source = [

]

val from_identifier : [< source ] -> t

val to_list : t -> (kind * string) list

val of_list : (kind * string) list -> t option

val split : 
  is_dir:(kind -> [ `Always | `Never | `IfNotLast ]) ->
  (kind * string) list ->
  (kind * string) list * (kind * string) list

split is_dir path splits the list path into a directory and filename, based on the is_dir function. The function is_dir should return whether or not the path element kind should be a directory or not. If the function is_dir returns `IfNotLast then the element will be a directory only if it is not the last element in the path. The return value is a tuple of directory-type elements and filename-type elements. If the is_dir function can return `Always, the caller must be prepared to handle the case where the filename part is empty.