XML tags in JavaDoc comments may not work

[mhdirkse]

In Constants.java, I was updating the documentation of the <Module> tag. In the text, I added the word <Module>, but that word was omitted from the text rendered in the Frank!Doc webpage. I can investigate whether this issue applies to JavaDoc comments in the F!F code as well.

[mhdirkse]

Update: We should tag that escaped HTML is rendered correctly. We should check that valid HTML that is not escaped is used to mark-up the text.

[mhdirkse]

I tested whether this is really an issue and I think not. To test this, I added a class DummyPipe that implements IPipe in the F!F.

I viewed the description of an attribute in Eclipse:

This looks OK. There is a word "name" between that still appears. There is a word "element" between < and > that appears as <element>. The latter does not work in VSCode, but that is not a Frank!Doc issue.

The same DummyPipe appears in the Frank!Doc webapp as follows:

This looks OK.

[mhdirkse]

There may still be a problem with the description of <Module>, but fixing that is not worth the trouble I think. The description of <Module> is OK without HTML markup or quoted HTML tags.

[thomaspj10]

This can now be done with {@literal documentation for <element>}, which will automatically escape all XML tags.