To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
-
bigarray
-
dynlink
-
ocamlbytecomp
-
ocamlcommon
-
ocamlmiddleend
-
ocamloptcomp
-
odoc_info
-
stdlib
-
str
-
unix
Library
Module
Module type
Parameter
Class
Class type
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_infoA parameter is just a param_info.
Functions
val complete_name : parameter -> stringAccess to the name as a string. For tuples, parentheses and commas are added.
val typ : parameter -> Types.type_exprAccess to the complete type.
val names : parameter -> string listAccess to the list of names ; only one for a simple parameter, or a list for a tuple.
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_exprAccess to the type of a specific name.
- raises Not_found
if no type is associated to the given name.