package ocaml-base-compiler

  1. Overview
  2. Docs
Official release 5.1.1

Install 

dune-project
 Dependency

ocaml.org Edit opam file Versions (70)

Authors

  1. Xavier Leroy

Maintainers

  1. David Allsopp
  2. F
    Florian Angeletti <florian.angeletti@inria.fr>

Sources

5.1.1.tar.gz
sha256=57f7b382b3d71198413ede405d95ef3506f1cdc480cda1dca1e26b37cb090e17

doc/odoc_info/Odoc_parameter/index.html

Module Odoc_parameter

Representation and manipulation of method / function / class parameters.

Types

type simple_name = {
  1. sn_name : string;
  2. sn_type : Types.type_expr;
  3. mutable sn_text : Odoc_types.text option;
}

Representation of a simple parameter name

type param_info =
  1. | Simple_name of simple_name
  2. | 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.

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.

  • raises Not_found

    if no description is associated to the given 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.

  • raises Not_found

    if no type is associated to the given 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.