View source | Edit

see annotation

The see annotation documents some other program element which is relevant to the annotated program element.

Usage

The annotation accepts one or more program element reference expressions.

see (`class Foo`)
void example() {
}

see (`function example`, 
     `package com.example.examples`)
class Foo() {
}

Description

The see annotation is processed by the ceylon doc tool.

See also