You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: frank-doc-doclet/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -181,7 +181,7 @@ You see the description in the JavaDoc comment (or [@IbisDoc](https://github.com
181
181
## Attribute default value (or Java annotation @Default)
182
182
183
183
You can document a default value for attributes. The preferred way to do this is using JavaDoc tag `@ff.default` or using
184
-
Java annotation `nl.nn.adapterframework.doc.Default`. Using the [@IbisDoc](https://github.com/ibissource/iaf/blob/master/core/src/main/java/nl/nn/adapterframework/doc/IbisDoc.java) Java annotation is deprecated. You document here what value is assumed if the attribute is not set. Only document this value if this default is applied already by the F!F source code. The `@ff.default` JavaDoc annotation does not alter the behavior of the Frank!Framework.
184
+
Java annotation `org.frankframework.doc.Default`. Using the [@IbisDoc](https://github.com/ibissource/iaf/blob/master/core/src/main/java/nl/nn/adapterframework/doc/IbisDoc.java) Java annotation is deprecated. You document here what value is assumed if the attribute is not set. Only document this value if this default is applied already by the F!F source code. The `@ff.default` JavaDoc annotation does not alter the behavior of the Frank!Framework.
185
185
186
186
Here is how it looks like in the Java source code:
187
187
@@ -266,11 +266,11 @@ Now we can see the meaning of the `@ff.defaultElement` tag. You can use it to pr
The default value is `nl.nn.adapterframework.pipes.SenderPipe` in this example. The autocomplete function of VSCode can add this default value for the `className` attribute. If it is omitted in a Frank config, then it is assumed to have the default value. You can thus use `<Pipe>` (without `className` attribute) as a synonym of `<SenderPipe>` because `<SenderPipe>` points to Java class [SenderPipe](https://github.com/ibissource/iaf/blob/master/core/src/main/java/nl/nn/adapterframework/pipes/SenderPipe.java).
269
+
The default value is `org.frankframework.pipes.SenderPipe` in this example. The autocomplete function of VSCode can add this default value for the `className` attribute. If it is omitted in a Frank config, then it is assumed to have the default value. You can thus use `<Pipe>` (without `className` attribute) as a synonym of `<SenderPipe>` because `<SenderPipe>` points to Java class [SenderPipe](https://github.com/ibissource/iaf/blob/master/core/src/main/java/nl/nn/adapterframework/pipes/SenderPipe.java).
270
270
271
271
**@ff.mandatory:** JavaDoc tag that applies to attribute setters and config child setters. If an attribute setter has this annotation, then the attribute definition in the strict XSD gets a `use="required"` attribute. Frank developers will see an error in their text editor if they omit the attribute / config child. If the annotation has no arguments, the compatibility XSD is affected in the same way. Configurations in which the attribute or config child is not set will not load. If you give this annotation the value `ignoreInCompatibilityMode`, the attribute or config child will not be mandatory in `FrankConfig-compatibility.xsd`, but will be mandatory in `FrankConfig-strict.xsd`.
272
272
273
-
**@Mandatory:** Java annotation that does the same as JavaDoc tag `@ff.mandatory`. Full name is `nl.nn.adapterframework.doc.Mandatory`. There is a Boolean field `ignoreInCompatibilityMode` that can make an attribute or config child optional in `FrankConfig-compatibility.xsd` and mandatory in `FrankConfig-strict.xsd`. The Boolean field has default vaue `false`, which means that the modeled attribute or config child is mandatory both in `FrankConfig-strict.xsd` and `FrankConfig-compatibility.xsd`.
273
+
**@Mandatory:** Java annotation that does the same as JavaDoc tag `@ff.mandatory`. Full name is `org.frankframework.doc.Mandatory`. There is a Boolean field `ignoreInCompatibilityMode` that can make an attribute or config child optional in `FrankConfig-compatibility.xsd` and mandatory in `FrankConfig-strict.xsd`. The Boolean field has default vaue `false`, which means that the modeled attribute or config child is mandatory both in `FrankConfig-strict.xsd` and `FrankConfig-compatibility.xsd`.
274
274
275
275
**@ff.optional:** JavaDoc tag that undoes the effect of an inherited `@ff.mandatory` or `@Mandatory`. Makes an attribute or config child optional even if it overrides a mandatory attribute or config child.
276
276
@@ -282,4 +282,4 @@ The default value is `nl.nn.adapterframework.pipes.SenderPipe` in this example.
282
282
283
283
**@ff.reintroduce:** JavaDoc tag that does the same as Java annotation `@Reintroduce`.
284
284
285
-
**@Label:** Java annotation that appears on other Java annotations, e.g <code>@Category</code>. A target annotation that is itself annotated with meta-annotation `@Label` produces a label in the Frank!Doc webapp when it is applied above a class of the Frank!Framework sources. The value of the label comes from the `value()` field of the target annotation. The name of the label comes from the `@Label` meta-annotation within the definition of the target annotation; attribute `name`. Labels only apply to classes, not child elements and not attributes. You can have enum-valued label values. In this case, the @EnumLabel annotation is supported. The JSON file that feeds the Frank!Doc webapp provides for each label an overview of all possible values. The label values are sorted alphabetically for non-enum values. Enum values are sorted by the order in the enum type.
285
+
**@Label:** Java annotation that appears on other Java annotations, e.g <code>@Category</code>. A target annotation that is itself annotated with meta-annotation `@Label` produces a label in the Frank!Doc webapp when it is applied above a class of the Frank!Framework sources. The value of the label comes from the `value()` field of the target annotation. The name of the label comes from the `@Label` meta-annotation within the definition of the target annotation; attribute `name`. Labels only apply to classes, not child elements and not attributes. You can have enum-valued label values. In this case, the @EnumLabel annotation is supported. The JSON file that feeds the Frank!Doc webapp provides for each label an overview of all possible values. The label values are sorted alphabetically for non-enum values. Enum values are sorted by the order in the enum type.
0 commit comments