org.eclipse.golo.doc

Interface DocumentationElement

All Superinterfaces:

java.lang.Comparable<DocumentationElement>

All Known Implementing Classes:

ModuleDocumentation

public interface DocumentationElement
extends java.lang.Comparable<DocumentationElement>

Method Summary

Modifier and Type	Method and Description
default int	compareTo(DocumentationElement other)
java.lang.String	documentation() The documentation comment for the element.
default java.lang.String	fullName() The fully qualified named of the element.
default boolean	hasDocumentation() Chech if this element has a documentation.
default java.lang.String	id() A unique identifier for the element.
default java.lang.String	label() A readable representation of the element.
int	line() The line where the element is defined.
java.lang.String	name() The simple name of the element.
DocumentationElement	parent() The parent element.
java.lang.String	type() A readable name for the kind of element.

Method Detail

name

java.lang.String name()

The simple name of the element.

documentation

java.lang.String documentation()

The documentation comment for the element.

hasDocumentation

default boolean hasDocumentation()

Chech if this element has a documentation.

An element has a documentation if its documentation() method returns a non null non empty (when trimmed) string.

line

int line()

The line where the element is defined.

parent

DocumentationElement parent()

The parent element.

For toplevel element, this is the module. For functions, it can be the augmentation. For union values, it is the union.

type

java.lang.String type()

A readable name for the kind of element.

fullName

default java.lang.String fullName()

The fully qualified named of the element.

Typically, the parent full name and the element name.

id

default java.lang.String id()

A unique identifier for the element.

Can be used in html ID for instance.

label

default java.lang.String label()

A readable representation of the element.

Typically the name, but can also contains argument names for functions for instance.

compareTo

default int compareTo(DocumentationElement other)

Specified by:

compareTo in interface java.lang.Comparable<DocumentationElement>