//Artefact:JavaClass/com/sphenon/basics/doclet/Doclet

Synopsis

public interface Doclet implements MonitorableCoreObject, DocletItem

Overview

Doclets are snippets of documentation, tagged with well defined meta data. Doclets comprise all kinds of documentation, i.e. human readable text. Like source code comments, which are e.g. attached to classes or members, Doclets are associated with all kinds of artefacts of a software system: with bundles, models, ocps, templates, and source code.

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getDocBook

Synopsis

public java.lang.String getDocBook (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getDocletType

Synopsis

public java.lang.String getDocletType (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getSecurityClass

Synopsis

public java.lang.String getSecurityClass (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getAudience

Synopsis

public java.lang.String getAudience (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getLanguage

Synopsis

public java.lang.String getLanguage (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getIntent

Synopsis

public java.lang.String getIntent (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getExtent

Synopsis

public java.lang.String getExtent (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getCoverage

Synopsis

public java.lang.String getCoverage (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getMaturity

Synopsis

public java.lang.String getMaturity (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getForm

Synopsis

public java.lang.String getForm (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getLayout

Synopsis

public java.lang.String getLayout (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getStyle

Synopsis

public java.lang.String[] getStyle (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getEncoding

Synopsis

public com.sphenon.basics.encoding.Encoding getEncoding (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getAspect

Synopsis

public java.lang.String getAspect (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getEntity

Synopsis

public java.lang.String getEntity (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getEntityType

Synopsis

public java.lang.String getEntityType (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getEntityVersion

Synopsis

public java.lang.String getEntityVersion (CallContext context)

//Artefact:Method/com/sphenon/basics/doclet/Doclet/getDocletVersion

Synopsis

public java.lang.String getDocletVersion (CallContext context)