Skip to content

telosys-tools-bricks/telosys-doc

Repository files navigation

Telosys user documentation

This project contains the generator documentation in HTML format

  • Velocity templating language (static files)
    • Velocity syntax
    • Velocity standard directives
    • Velocity Telosys specific directives
  • Telosys objects usable objects in the templates (generated files)
  • Telosys target languages specificities (generated files)

To guarantee the reliability of the documentation some HTML files are generated by Telosys components.

The Java tooling to generate the user documentation is also located in this project.

Documentation generation is done with the following Java methods :

  • ObjectsDocumentation.genDoc()
    to generate the documentation of all usable objects in the templates

  • LanguagesDocumentation.genDoc()
    to generate the documentation of all target languages specificities