# Module edoc_types

Datatype representation for EDoc.

Copyright © 2001-2003 Richard Carlsson

- Description
- Data Types
- Function Index
- Function Details

Authors: Richard Carlsson (`richardc@csd.uu.se`).

See also: edoc.

## Description

Datatype representation for EDoc.

## Data Types

### t_atom()

`t_atom() = #t_atom{a = list(), val = atom()}`

### t_def()

`t_def() = #t_def{name = t_name(), type = type()}`

### t_field()

`t_field() = #t_field{a = list(), name = type(), type = type()}`

### t_float()

`t_float() = #t_float{a = list(), val = float()}`

### t_fun()

`t_fun() = #t_fun{a = list(), args = [type()], range = type()}`

### t_integer()

`t_integer() = #t_integer{a = list(), val = integer()}`

### t_list()

`t_list() = #t_list{a = list(), type = type()}`

### t_name()

`t_name() = #t_name{app = [] | atom(), module = [] | atom(), name = [] | atom()}`

### t_nil()

`t_nil() = #t_nil{a = list()}`

### t_record()

`t_record() = #t_list{a = list(), name = type(), fields = [field()]}`

### t_spec()

`t_spec() = #t_spec{name = t_name(), type = t_type(), defs = [t_def()]}`

### t_throws()

`t_throws() = #t_throws{type = type(), defs = [t_def()]}`

### t_tuple()

`t_tuple() = #t_tuple{a = list(), types = [type()]}`

### t_type()

`t_type() = #t_type{a = list(), name = t_name(), args = [type()]}`

### t_typedef()

`t_typedef() = #t_typedef{name = t_name(), args = [type()], type = type(), defs = [t_def()]}`

### t_union()

`t_union() = #t_union{a = list(), types = [type()]}`

### t_var()

`t_var() = #t_var{a = list(), name = [] | atom()}`

### type()

`type() = t_atom() | t_fun() | t_integer() | t_list() | t_nil() | t_tuple() | t_type() | t_union() | t_var()`

## Function Index

arg_names/1 |
is_predefined/1 |
set_arg_names/2 |
to_label/1 |
to_ref/1 |
to_xml/2 |

## Function Details

### arg_names/1

`arg_names(T_spec) -> term()`

### is_predefined/1

`is_predefined(X1) -> term()`

### set_arg_names/2

`set_arg_names(T_spec, As1) -> term()`

### to_label/1

`to_label(N) -> term()`

### to_ref/1

`to_ref(T_typedef) -> term()`

### to_xml/2

`to_xml(T_var, Env) -> term()`