org.eclipse.golo.doc

Class ModuleDocumentation

java.lang.Object

org.eclipse.golo.doc.ModuleDocumentation

All Implemented Interfaces:

java.lang.Comparable<DocumentationElement>, DocumentationElement

public class ModuleDocumentation
extends java.lang.Object
implements DocumentationElement

Method Summary

Modifier and Type	Method and Description
java.util.Collection<org.eclipse.golo.doc.AugmentationDocumentation>	augmentations()
java.lang.String	documentation() The documentation comment for the element.
static ModuleDocumentation	empty(java.lang.String name)
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()
boolean	isEmpty()
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()
ModuleDocumentation	moduleDocumentation(java.lang.String doc)
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()
java.lang.String	packageName()
DocumentationElement	parent() The parent element.
java.lang.String	sourceFile()
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

Methods inherited from interface org.eclipse.golo.doc.DocumentationElement

compareTo, hasDocumentation

Method Detail

type

public java.lang.String type()

A readable name for the kind of element.

Specified by:

type in interface DocumentationElement

load

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

Throws:

java.io.IOException

empty

public static ModuleDocumentation empty(java.lang.String name)

isEmpty

public boolean isEmpty()

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)

sourceFile

public java.lang.String sourceFile()

moduleName

public java.lang.String moduleName()

packageName

public java.lang.String packageName()

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.

Specified by:

label in interface DocumentationElement

name

public java.lang.String name()

The simple name of the element.

Specified by:

name in interface DocumentationElement

fullName

public java.lang.String fullName()

The fully qualified named of the element.

Typically, the parent full name and the element name.

Specified by:

fullName in interface DocumentationElement

id

public java.lang.String id()

A unique identifier for the element.

Can be used in html ID for instance.

Specified by:

id in interface DocumentationElement

parent

public 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.

Specified by:

parent in interface DocumentationElement

moduleDefLine

public int moduleDefLine()

line

public int line()

The line where the element is defined.

Specified by:

line in interface DocumentationElement

moduleDocumentation

public java.lang.String moduleDocumentation()

moduleDocumentation

public ModuleDocumentation moduleDocumentation(java.lang.String doc)

documentation

public java.lang.String documentation()

The documentation comment for the element.

Specified by:

documentation in interface DocumentationElement

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()