Documentation generation

This page contains informations about the documentation generation feature.

Ecore to sphinx documentation generation

A small Acceleo plugin has been developed in order to generate documentation about a meta-model elements. This is based on three types of annotations (ECore EAnnotation):

  • GenModel annotations

    These annotation must have a Source attribute set to: http://www.eclipse.org/emf/2002/GenModel. The Details entries must have a Key set to documentation and the Value must contain the specification to be printed.

  • Note annotations

    These annotations must have a Source attribute set to: http://www.irit.fr/EcoreGenDoc/Note. The Details entries may contain a Key that will be the title of the note and the value is the content of the note. Notes are used for precisions about the values, multiplicities or other informations that must not be merged inside general purpose documentation that is on the GenModel annotations.

    The printing of these elements is not very convenient and must be reviewed for better integration in the generation and final document.

  • Todo annotations

    These annotations must have a Source attribute set to: http://www.irit.fr/EcoreGenDoc/Todo. The Details entries may contain a Key that will be the title of the Todo and the value is the content of the Todo. Todos are used for displaying informations on future implementation/refactorings of the metamodel or questions that must be answered.

    The printing of these elements is not very convenient and must be reviewed for better integration in the generation and final document.

  • Intro annotations

    These annotations must have a Source attribute set to: http://www.irit.fr/EcoreGenDoc/Intro. The Details entry values will be used as a text for introduction be fore the main package documentation. Intro annotations are only used in the main package of the documented metamodel.

  • Definition

    It is possible to express operation definitions (methods and variables declarations by adding a new annotation with the Source attribute set as http://www.irit.fr/EcoreGenDoc/Algo. The key of the annotation is used as the name of the definition.

  • Invariant specification

    It si possible to define invariants. THese Invariants are specified in a new annotation using the Source attribute set as http://www.irit.fr/EcoreGenDoc/Invariant. The key of the annotation is the name of the invariant. Context of the invariant is the element on which the annotation is attached.

This plugin can be found as jar files in the plugins folder:

  • org.irit.emf.ecore.docgen_1.0.0.*.jar
  • org.irit.emf.ecore.docgen.ui_1.0.0.*.jar

Table Of Contents

Previous topic

Form Editor

Next topic

From BlockLibrary to P_Toolset

This Page