org.eclipse.golo.doc

Class ModuleDocumentation

java.lang.Object

org.eclipse.golo.doc.ModuleDocumentation

public class ModuleDocumentation
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
java.util.Collection<org.eclipse.golo.doc.AugmentationDocumentation>	augmentations()
default int	compareTo(org.eclipse.golo.doc.DocumentationElement other)
java.lang.String	documentation() The documentation comment for the element.
java.lang.String	fullName() The fully qualified named of the element.
java.util.SortedSet<org.eclipse.golo.doc.FunctionDocumentation>	functions()
java.util.SortedSet<org.eclipse.golo.doc.FunctionDocumentation>	functions(boolean withLocal)
java.lang.String	goloVersion()
java.lang.String	id() A unique identifier for the element.
java.util.Map<java.lang.String,java.lang.Integer>	imports()
default java.lang.String	label() A readable representation of the element.
int	line() The line where the element is defined.
static ModuleDocumentation	load(java.lang.String filename, GoloCompiler compiler)
int	moduleDefLine()
java.lang.String	moduleDocumentation()
java.lang.String	moduleName()
java.util.Map<java.lang.String,java.lang.Integer>	moduleStates()
java.lang.String	name() The simple name of the element.
java.util.Collection<org.eclipse.golo.doc.NamedAugmentationDocumentation>	namedAugmentations()
org.eclipse.golo.doc.DocumentationElement	parent() The parent element.
java.util.SortedSet<org.eclipse.golo.doc.StructDocumentation>	structs()
java.lang.String	type() A readable name for the kind of element.
java.util.SortedSet<org.eclipse.golo.doc.UnionDocumentation>	unions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

type

public java.lang.String type()

A readable name for the kind of element.

load

public static ModuleDocumentation load(java.lang.String filename,
                                       GoloCompiler compiler)
                                throws java.io.IOException

Throws:

java.io.IOException

goloVersion

public java.lang.String goloVersion()

structs

public java.util.SortedSet<org.eclipse.golo.doc.StructDocumentation> structs()

unions

public java.util.SortedSet<org.eclipse.golo.doc.UnionDocumentation> unions()

functions

public java.util.SortedSet<org.eclipse.golo.doc.FunctionDocumentation> functions()

functions

public java.util.SortedSet<org.eclipse.golo.doc.FunctionDocumentation> functions(boolean withLocal)

moduleName

public java.lang.String moduleName()

name

public java.lang.String name()

The simple name of the element.

fullName

public java.lang.String fullName()

The fully qualified named of the element.

Typically, the parent full name and the element name.

id

public java.lang.String id()

A unique identifier for the element.

Can be used in html ID for instance.

parent

public org.eclipse.golo.doc.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.

moduleDefLine

public int moduleDefLine()

line

public int line()

The line where the element is defined.

moduleDocumentation

public java.lang.String moduleDocumentation()

documentation

public java.lang.String documentation()

The documentation comment for the element.

moduleStates

public java.util.Map<java.lang.String,java.lang.Integer> moduleStates()

augmentations

public java.util.Collection<org.eclipse.golo.doc.AugmentationDocumentation> augmentations()

namedAugmentations

public java.util.Collection<org.eclipse.golo.doc.NamedAugmentationDocumentation> namedAugmentations()

imports

public java.util.Map<java.lang.String,java.lang.Integer> imports()

label

public java.lang.String label()

A readable representation of the element.

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

compareTo

public int compareTo(org.eclipse.golo.doc.DocumentationElement other)

Specified by:

compareTo in interface java.lang.Comparable<org.eclipse.golo.doc.DocumentationElement>