Package com.jogamp.gluegen

Class JavaMethodBindingEmitter.DefaultCommentEmitter

java.lang.Object

com.jogamp.gluegen.JavaMethodBindingEmitter.DefaultCommentEmitter

All Implemented Interfaces:

CommentEmitter

Direct Known Subclasses:

JavaMethodBindingEmitter.InterfaceCommentEmitter, ProcAddressJavaMethodBindingEmitter.WrappedMethodCommentEmitter

Enclosing class:

JavaMethodBindingEmitter

protected class JavaMethodBindingEmitter.DefaultCommentEmitter
extends Object
implements CommentEmitter

Class that emits a generic comment for JavaMethodBindingEmitters; the comment includes the C signature of the native method that is being bound by the emitter java method.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultCommentEmitter()

Method Summary

Modifier and Type	Method	Description
void	emit(FunctionEmitter emitter, PrintWriter writer)	Emit the body of a comment for the specified function; do NOT emit the open (e.g., comment "/*") or close (e.g., "*\/") characters.
protected void	emitAliasedDocNamesComment(AliasedSymbol sym, PrintWriter writer)
protected StringBuilder	emitAliasedDocNamesComment(AliasedSymbol sym, StringBuilder sb)
protected void	emitBeginning(FunctionEmitter emitter, PrintWriter writer)
protected void	emitBindingCSignature(MethodBinding binding, PrintWriter writer)
protected void	emitEnding(FunctionEmitter emitter, PrintWriter writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCommentEmitter

protected DefaultCommentEmitter()

Method Detail

emitAliasedDocNamesComment

protected void emitAliasedDocNamesComment(AliasedSymbol sym,
                                          PrintWriter writer)

emitAliasedDocNamesComment

protected StringBuilder emitAliasedDocNamesComment(AliasedSymbol sym,
                                                   StringBuilder sb)

emit

public void emit(FunctionEmitter emitter,
                 PrintWriter writer)

Description copied from interface: CommentEmitter

Emit the body of a comment for the specified function; do NOT emit the open (e.g., comment "/*") or close (e.g., "*\/") characters.

Specified by:

emit in interface CommentEmitter

emitBeginning

protected void emitBeginning(FunctionEmitter emitter,
                             PrintWriter writer)

emitBindingCSignature

protected void emitBindingCSignature(MethodBinding binding,
                                     PrintWriter writer)

emitEnding

protected void emitEnding(FunctionEmitter emitter,
                          PrintWriter writer)