package ocaml-base-compiler

You can search for identifiers within the package.

in-package search v0.2.0

Official release 5.2.1

Install

sha256=2d0f8090951a97a2c0e5b8a11e90096c0e1791d2e471e4a67f87e3b974044cd0

Representation and manipulation of method / function / class parameters.

Types

type simple_name = {

}

Representation of a simple parameter name

type param_info =

| Simple_name of simple_name
| Tuple of param_info list * Types.type_expr
(*
Representation of parameter names. We need it to represent parameter names in tuples. The value Tuple ([], t) stands for an anonymous parameter.
*)

type parameter = param_info

A parameter is just a param_info.

Functions

val complete_name : parameter -> string

access to the name as a string. For tuples, parentheses and commas are added.

val typ : parameter -> Types.type_expr

access to the complete type

val update_parameter_text : 
  (string -> Odoc_types.text option) ->
  parameter ->
  unit

Update the text of a parameter using a function returning the optional text associated to a parameter name.

val desc_by_name : parameter -> string -> Odoc_types.text option

access to the description of a specific name.

val names : parameter -> string list

access to the list of names ; only one for a simple parameter, or a list for tuples.

val type_by_name : parameter -> string -> Types.type_expr

access to the type of a specific name.

val desc_from_info_opt : 
  Odoc_types.info option ->
  string ->
  Odoc_types.text option

access to the optional description of a parameter name from an optional info structure.