GiellaLT Documentation

GiellaLT provides rule-based language technology aimed at minority and indigenous languages

View GiellaLT on GitHub

Page Content

In-Source Documentation Specification

Doccomment variables and triggers

Trigger symbols (all are followed by space, with one exception):


The variables retain their values until they are reset (either by a new lexicon or rule name, or by a new !!≈ or !!= symbol).

Formatting of extracted comments

For all source files, the comments should be formatted using Markdown markup.

Build system behaviour

The build system will automatically find all source files containing documentation comments, and extract the markdown document. This happens on all pushes to GitHub.

The Markdown pages can also be built manually. Just type make, and the documentation will be rebuilt if needed.

There will also be built one large file, containing all the in-source documentation on one page.