frankframework icon indicating copy to clipboard operation
frankframework copied to clipboard

Frank!Doc documentation less than Javadoc documentation on schema and schemaLocation of XmlValidator

Open jacodg opened this issue 3 years ago • 0 comments

Describe the issue The page https://frankdoc.frankframework.org/#!/Validators/XmlValidator shows the following info:

schema | the filename of the schema on the classpath. see doc on the method. (effectively the same as noNamespaceSchemaLocation) | schemaLocation | Pairs of uri references (one for the namespace name, and one for a hint as to the location of a schema document defining names for that namespace name). see doc on the method.

While the Javadoc on the same methods contain more info which the Frank developer will not see:

 * <p>
 * The filename of the schema on the classpath. It is not possible to specify a
 * namespace using this attribute.
 * <p>
 * An example value would be "xml/xsd/GetPartyDetail.xsd"
 * </p>
 * <p>
 * The value of the schema attribute is only used if the schemaLocation
 * attribute and the noNamespaceSchemaLocation are not set
 * </p>

 * <p>Pairs of URI references (one for the namespace name, and one for a
 * hint as to the location of a schema document defining names for that
 * namespace name).</p>
 * <p> The syntax is the same as for schemaLocation attributes
 * in instance documents: e.g, "http://www.example.com file%20name.xsd".</p>
 * <p>The user can specify more than one XML Schema in the list.</p>
 * <p><b>Note</b> that spaces are considered separators for this attributed.
 * This means that, for example, spaces in filenames should be escaped to %20.
 * </p>

Can all the available info be exposed to the Frank developers? Maybe the same is true for other attributes, pipes, sender, ...? Do we need somebody to go through all the available Javadoc and Frank!Doc?

Reporter Jaco de Groot

jacodg avatar Mar 11 '22 17:03 jacodg