search

frankframework / frank-doc

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

Introduce java annotation @Optional and javadoc tag @ff.optional #68

Closed gvanbrakel closed 2 years ago

gvanbrakel commented 2 years ago

Optional overrides any mandatory setting. Example use case: AbstractPipe.setName() will get a @ff.mandatory annotation IWrapperPipe.setName() and IValidator.setName() will get a @Optional annotation or a @ff.optional javadoc tag, to avoid having to set a name for wrappers and validators

mhdirkse commented 2 years ago

In the use case you explain Java annotation @Optional. What is the meaning of JavaDoc tag @ff.optional? Do they do the same or is there a difference?

gvanbrakel commented 2 years ago

They are meant to be the same

mhdirkse commented 2 years ago

Oh, I understand. I should have read issue #69 before writing...

mhdirkse commented 2 years ago

Please also consider PR https://github.com/ibissource/iaf/pull/2808.