NCL Website header
NCL Home > Documentation > HLUs

HLU API reference page format

This module describes the layout of the reference page for the HLU APIs.

API name

This section lists the Fortran function name(s) and provides a brief overview of the API.

C Synopsis

This section lists the include files that are needed in order to use the API. It also lists the API syntax for a C program.

Fortran Synopsis

This section lists the include files that are needed in order to use the API. It also lists the API syntax for a Fortran program.

Arguments

This section lists the arguments used in the API and gives a brief description of their meaning.

Types

This section lists the relevant types that are used by the API.

Description

This section gives a detailed overview of how to use the API, and it explains the functionality that is available.

Return Values

This section lists return values from the function.

See also

This section lists related topics.