org.eclipse.etrice.generator.doc.gen
Class DocGen

java.lang.Object
  extended by org.eclipse.etrice.generator.doc.gen.DocGen
All Implemented Interfaces:
IRoomGenerator


Constructor Summary
DocGen()
          
Method Summary
 void doGenerate(Root root)
          
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocGen

public DocGen()
Method Detail

doGenerate

public void doGenerate(Root root)
Description copied from interface: IRoomGenerator
generate code from an eTrice generator model

Specified by:
doGenerate in interface IRoomGenerator
Parameters:
root - the root object of the eTrice generator model

generateModelDoc

public StringConcatenation generateModelDoc(Root root,
                                            RoomModel model)

generateAllDataClassDocs

public StringConcatenation generateAllDataClassDocs(Root root,
                                                    RoomModel model)

generateDataClassDoc

public StringConcatenation generateDataClassDoc(Root root,
                                                DataClass dc)

generateAllProtocolClassDocs

public StringConcatenation generateAllProtocolClassDocs(Root root,
                                                        RoomModel model)

generateProtocolClassDoc

public StringConcatenation generateProtocolClassDoc(Root root,
                                                    ProtocolClass pc)

generateAllActorClassDocs

public StringConcatenation generateAllActorClassDocs(Root root,
                                                     RoomModel model)

generateActorClassDoc

public StringConcatenation generateActorClassDoc(Root root,
                                                 RoomModel model,
                                                 ActorClass ac)

generateFsmDoc

public StringConcatenation generateFsmDoc(RoomModel model,
                                          ActorClass ac)

generateStateDoc

public StringConcatenation generateStateDoc(RoomModel model,
                                            ActorClass ac,
                                            State state)

generateAttributesDoc

public StringConcatenation generateAttributesDoc(java.util.List<Attribute> attributes)

generateOperationsDoc

public StringConcatenation generateOperationsDoc(java.util.List<StandardOperation> operations)

generateDocText

public StringConcatenation generateDocText(Documentation doc)

fileExists

public java.lang.String fileExists(java.lang.String f)

includeGraphics

public StringConcatenation includeGraphics(java.lang.String filename,
                                           java.lang.String scale,
                                           java.lang.String caption)

irgendwas

public java.lang.String irgendwas(Root root,
                                  ActorClass ac)