Gendoc/developerResources/architecture

Features & Bundles

• org.eclipse.gendoc.feature
  • all the common bundles needed to use Gendoc
  • org.eclipse.gendoc.batch
  • org.eclipse.gendoc.bundle.acceleo.commons
  • org.eclipse.gendoc.bundle.acceleo.gmf
  • org.eclipse.gendoc.document.parser
  • org.eclipse.gendoc.documents.image.svg
  • org.eclipse.gendoc.documents
  • org.eclipse.gendoc.m2t
  • org.eclipse.gendoc.process
  • org.eclipse.gendoc.script.acceleo
  • org.eclipse.gendoc.services.docx
  • org.eclipse.gendoc.services.odt
  • org.eclipse.gendoc.services
  • org.eclipse.gendoc.tags.handlers
  • org.eclipse.gendoc.tags.html
  • org.eclipse.gendoc.tags.hyperlink
  • org.eclipse.gendoc.tags.parsers
  • org.eclipse.gendoc.tags
  • org.eclipse.gendoc.ui
  • org.eclipse.gendoc.wizard.gmf
  • org.eclipse.gendoc.wizard
  • org.eclipse.gendoc
• org.eclipse.gendoc.papyrus.feature
  • specific bundles (diagram and queries) for Papyrus
  • org.eclipse.gendoc.wizard.papyrus
  • org.eclipse.gendoc.bundle.acceleo.papyrus
• org.eclipse.gendoc.sirius.feature
  • specific bundles (diagram and queries) for Sirius
  • org.eclipse.gendoc.bundle.acceleo.sirius

List of Services

all of the declared services bellow can be overridden by a developer using the extension point org.eclipse.gendoc.services

org.eclipse.gendoc.tags.handler

IConfigurationService

• The service linked to config tag
• information about : parameters, output path ...

IContextService

• the service linked to context tag
• information about : model path, context eobject, path to the eobject, the way to compute path ...

IPropertiesService

• the service linked to properties tag
• load a file to register parameters

ITagHandlerService

• the service used by gendoc to determine handlers from an org.eclipse.gendoc.tags.ITag

IEMFModelLoaderService

• the service which loads EMF models
• used mainly by the IConfigurationService

Processes

Processes in gendoc are java classes which implement org.eclipse.gendoc.process.IProcess (or inherit from org.eclipse.gendoc.process.AbstractProcess)

A process is declared through the extension point : org.eclipse.gendoc.processes.

Each Process mentions its id, label, if it can run in parallel, priority, and java class (processor)

It is also possible to mention predecessors or successors. It is gendo engine which schedule the processes

List of processes

org.eclipse.gendoc.process

• countSteps
  • A process that identifies the number of steps in the document (useful for the gendoc progress monitor)

org.eclipse.gendoc

• generate
  • predecessor : countSteps
  • parse and analyse the tags in the document

• save
  • predecessor : generate

• additionalResources
  • predecessor : generate
  • successor : save
  • add the additional ressources potentially generated during the gendoc process