frankframework / frank-doc

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

Have a uniform approach for Frank!Doc annotations #138

Closed mhdirkse closed 1 year ago

mhdirkse commented 1 year ago

This issue is not about new features of the Frank!Doc, but about improving the code. The Frank!Doc introduces many annotations that can be set in the F!F sources. When the project started, only Java annotations were supported. Later, we wanted that Frank!Doc features could be invoked through JavaDoc tags in the F!F sources. We introduced features: pairs of a Java annotation and a JavaDoc tag that mean the same for the Frank!Doc.

We want every Java annotation or JavaDoc tag that is meaningful for the Frank!Doc to be part of a feature. Then the Frank!Doc sources show the overview of all supported Java annotations and JavaDoc tags.

@nielsm5, if we have this, can we then remove the file FRANKDOC.md from the iaf project? That file now documents all the tags and annotations. We could move the documentation there to the enum that defines the features.