package ocaml-base-compiler

You can search for identifiers within the package.

in-package search v0.2.0

Official release 4.08.1

Install

Dune Dependency

ocaml.org Edit opam file Versions (99)

Authors

Xavier Leroy

Maintainers

Sources

4.08.1.tar.gz

sha256=b53ed3d487b83fd49bc181bded066ae8e6fb592cf40514261d27d36050d5db85

md5=723b6bfe8cf5abcbccc6911143f71055

doc/odoc_info/Odoc_info/Parameter/index.html

Module `Odoc_info.Parameter`

Representation and manipulation of method / function / class / module parameters.

Types

type simple_name = Odoc_parameter.simple_name = {

sn_name : string;
sn_type : Types.type_expr;
mutable sn_text : text option;

}

Representation of a simple parameter name

type param_info = Odoc_parameter.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 names : parameter -> string list

Access to the list of names ; only one for a simple parameter, or a list for a tuple.

val desc_by_name : parameter -> string -> text option

Access to the description of a specific name.

raises Not_found
if no description is associated to the given name.

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

Access to the type of a specific name.

raises Not_found
if no type is associated to the given name.

On This Page

Types
Functions