frankframework / frank-doc

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

Check for suspicious html #125

Closed mhdirkse closed 2 years ago

mhdirkse commented 2 years ago

With the code up to this point, the output is as follows:

18:09:26,195 WARN  FrankDocModel.checkDescription():874[] Attribute [Receiver.hideRegex] has a description with suspicious HTML tags: [<party>]
18:09:26,199 WARN  FrankDocModel.checkDescription():874[] Attribute [JdbcTransactionalStorage.hideRegex] has a description with suspicious HTML tags: [<party>]
18:09:26,200 WARN  FrankDocModel.checkDescription():874[] Attribute [JdbcMessageBrowser.hideRegex] has a description with suspicious HTML tags: [<party>]
18:09:26,200 WARN  FrankDocModel.checkDescription():874[] Attribute [CommandSender.command] has a description with suspicious HTML tags: [<ALL>]
18:09:26,201 WARN  FrankDocModel.checkDescription():874[] Attribute [JmsTransactionalStorage.hideRegex] has a description with suspicious HTML tags: [<party>]
18:09:26,201 WARN  FrankDocModel.checkDescription():874[] Attribute [JmsMessageBrowser.hideRegex] has a description with suspicious HTML tags: [<party>]
18:09:26,201 WARN  FrankDocModel.checkDescription():874[] FrankElement [nl.nn.adapterframework.soap.SoapValidator] has a description with suspicious HTML tags: [<A>]
18:09:26,205 WARN  FrankDocModel.checkSuspiciousHtml():864[] Searching over the descriptions of elements, config children and attributes, the following suspicious HTML tags were found: [<ALL>, <A>, <party>]

You see here that elements and attributes are checked. I temporarily changed the JavaDoc of a config child to add an invalid tag. This way I saw that config children are also scanned for invalid tags. The output above is without that temporary change, SHA de536049562f13b9e7d79f848a72332b0b38e9a9