dox icon indicating copy to clipboard operation
dox copied to clipboard

Special characters not escaped correctly

Open tong opened this issue 4 years ago • 1 comments

Using special characters in non-code md breaks html rendering.

Example: https://api.armory3d.org/iron/Scene.html#getChildren
… html after @return is cluttered as it's defined as:

@return Array<Object>

This works:

@return `Array<Object>`

If this is intentional and not gonna get fixed it should be noted in the documentation.

tong avatar Oct 14 '21 15:10 tong

That's not intentional, although I would also argue @return hints like that are completely useless in a statically typed language.

Gama11 avatar Oct 14 '21 16:10 Gama11