org.apache.flex.compiler.codegen.js.goog

Interface IJSGoogDocEmitter

All Superinterfaces:

IDocEmitter, IJSDocEmitter

All Known Implementing Classes:

JSFlexJSDocEmitter, JSGoogDocEmitter, JSVF2JSDocEmitter

public interface IJSGoogDocEmitter
extends IJSDocEmitter

The IJSGoogDocEmitter interface allows the abstraction of JavaScript document comments to be emitted per tag.

The purpose of the API is to clamp emitted output to JavaScript doc tags. The output can be multiline but is specific to one tag. This allows a full comment to be created without worrying about how to assemble the tags.

The current tags were found at https://developers.google.com/closure/compiler/docs/js-for-compiler#types

TODO (mschmalle) Might make a comment API and tag API so comments are not dependent on tag creation IE IJSDocEmitter and IJSDocTagEmitter

Author:

Michael Schmalle

Method Summary

Methods

Modifier and Type	Method and Description
void	emitConst(IVariableNode node)
void	emitExtends(IClassDefinition superDefinition, String packageName)
void	emitFieldDoc(IVariableNode node, IDefinition def, ICompilerProject project)
void	emitImplements(ITypeDefinition definition, String packageName)
void	emitInterfaceDoc(IInterfaceNode node, ICompilerProject project)
void	emitInterfaceMemberDoc(IDefinitionNode node, ICompilerProject project)
void	emitMethodDoc(IFunctionNode node, ICompilerProject project)
void	emitOverride(IFunctionNode node)
void	emitParam(IParameterNode node, String packageName)
void	emitPrivate(IASNode node)
void	emitProtected(IASNode node)
void	emitPublic(IASNode node)
void	emitReturn(IFunctionNode node, String packageName)
void	emitThis(ITypeDefinition node, String packageName)
void	emitType(IASNode node, String packageName)
void	emitType(String type, String packageName)
void	emitVarDoc(IVariableNode node, IDefinition def, ICompilerProject project)

Methods inherited from interface org.apache.flex.compiler.codegen.IDocEmitter

begin, end, flushBuffer, setBufferWrite

Method Detail

emitInterfaceDoc

void emitInterfaceDoc(IInterfaceNode node,
                    ICompilerProject project)

emitInterfaceMemberDoc

void emitInterfaceMemberDoc(IDefinitionNode node,
                          ICompilerProject project)

emitFieldDoc

void emitFieldDoc(IVariableNode node,
                IDefinition def,
                ICompilerProject project)

emitMethodDoc

void emitMethodDoc(IFunctionNode node,
                 ICompilerProject project)

emitVarDoc

void emitVarDoc(IVariableNode node,
              IDefinition def,
              ICompilerProject project)

emitConst

void emitConst(IVariableNode node)

emitExtends

void emitExtends(IClassDefinition superDefinition,
               String packageName)

emitImplements

void emitImplements(ITypeDefinition definition,
                  String packageName)

emitOverride

void emitOverride(IFunctionNode node)

emitParam

void emitParam(IParameterNode node,
             String packageName)

emitPublic

void emitPublic(IASNode node)

emitPrivate

void emitPrivate(IASNode node)

emitProtected

void emitProtected(IASNode node)

emitReturn

void emitReturn(IFunctionNode node,
              String packageName)

emitThis

void emitThis(ITypeDefinition node,
            String packageName)

emitType

void emitType(IASNode node,
            String packageName)

emitType

void emitType(String type,
            String packageName)