Add events docs template + logic

This commit is contained in:
Urban Klinc
2020-12-04 14:27:13 +01:00
parent 401f3d2c7c
commit 3b47701ffa
3 changed files with 56 additions and 20 deletions
+37 -18
View File
@@ -4,26 +4,45 @@
// the code is regenerated.
//
// Definitions file that controls how this file is generated:
// {{ .Source }}
= {{ $.ResourceString }}
.List of events on `{{ $.ResourceString }}`
{{- range $event := $.Events.MakeEvents }}
- `{{ $event }}`
{{- range .Definitions }}
// - {{ .Source }}
{{- end }}
.Event arguments for `{{ $.ResourceString }}`
[%header,cols=3*]
|===
|Name
|Type
|Immutable
{{- range .Definitions }}
{{- range .Resources }}
{{- range $p := $.Events.Properties }}
|`{{ camelCase $p.Name }}`
|`{{ $p.Type }}`
|{{ $p.Immutable }}
= {{ .ResourceString }}
== Events
.Events:
{{- range $ba := .BeforeAfter }}
* `before('{{ $ba }}')`
{{- end }}
{{- range $ba := .BeforeAfter }}
* `after('{{ $ba }}')`
{{- end }}
{{- range $on := .On }}
* `on('{{ $on }}')`
{{- end }}
== Argument properties
.Argument properties:
[%header, cols=3*]
|===
|Name|Type|Immutable
{{- range $p := .Properties }}
| `{{ $p.Name }}`
| `{{ $p.Type }}`
{{- if $p.Immutable }}
| yes
{{ else }}
| no
{{ end -}}
{{ end -}}
|===
{{- end }}
{{- end }}