leigh/neogen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Daniel Mathiot
2021-08-31 12:20:24 +02:00
parent 0c2c865ce0
commit 7c7d03e665
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/adding-languages.md
View File

@@ -150,7 +150,9 @@ template = {
},
```
The `annotation_convention` field will use the desired annotation template.
- The `annotation_convention` field will use the desired annotation template.
- Adding `use_default_comment = false` will not prepend the language's default comment before the template
- If you want to customize the position of the annotated text, you can add `append = { position = "<before|after>", child_name = "<node_name>"}`
An annotation template is a set of tables, each one composed of 2 required params, and 1 optional table
@@ -161,6 +163,7 @@ An annotation template is a set of tables, each one composed of 2 required param
- the optional params:
- `no_results`: (bool, default false) will only use this field when there is no value returned by the granulator
- `type`: (string[], default nil) will only use this field for the required types. If not specified, it will use this field for all types
- `before_first_item`: (string[], default nil) will append the lines before the first found item for the table