frankframework / frank-doc

Frank!Doc
https://frankdoc.frankframework.org
Apache License 2.0
4 stars 5 forks source link

Support for Labels #130

Closed gvanbrakel closed 1 year ago

gvanbrakel commented 2 years ago

Aan het frank framework zijn de meta-annotaties @Label en @LabelValue opgenomen. Hiermee kunnen andere annotaties geannoteerd worden, waarmee dan categorieen en tags aan de source toegevoegd kunnen worden. Een voorbeeld is de annotatie @Category. Deze is op een aantal plekken in het framework gezet bijvoorbeeld:

@Category("Basic")
public class XsltPipe extends ....  {
@Category("Advanced")
public class IsUserInRolePipe extends ... {

De frankdoc generator moet deze labels gaan parsen, door gebruik te maken van @Label en @LabelValue. Hij moet er op die manier achterkomen dat @Category en @SupportsOutputStreaming labels bestaan, en die in de json opnemen in een structuur als:

"labels": [
{ "label": "<@Label.name()>", "value": "<@LabelValue.value>"},
 ...
]