-
Notifications
You must be signed in to change notification settings - Fork 1
Documentation
Mishin870 edited this page Jul 26, 2018
·
2 revisions
Engine can generate documentation entries about every thing in current configuration (current local functions, global functions. in future, generator will export objects and object.functions())
To generate documentation:
List<IDocumentationEntry> docs = engine.getDocumentation();
Then you can getTitle()
, getDescription()
or getType()
of all generated documentation entries.
There are multiple types of documentation entries (but for now only FunctionEntry
) and you can use getType()
to recognize type of entry without a cast.
You can use it in autocompletion in code editor or simply display it:
foreach (IDocumentationEntry entry in docs) {
MessageBox.Show(entry.ToString());
}