search

dlang / ddox

Advanced D documentation engine
MIT License
63 stars 21 forks source link

Only a small part of docs is generated #246

Closed trikko closed 1 year ago

trikko commented 1 year ago

Using ddox with parserino only a small part of docs is generated for struct Document, not sure why. It sounds like a bug. I can see all the methods inside docs.json.

trikko commented 1 year ago

Ok, got it. It doesn't escape tags inside docs, is this a feature? A comment like this make a mess:

/// The <body> tag content

This fixes the problem and show all missing methods

/// The `<body>` tag content
WebFreak001 commented 1 year ago

since HTML escaping is not really part of DDOC and in fact is actually how you implement advanced outputs in HTML DDOC macros, I don't think preventing the user from messing up the HTML like this would be scope of ddox.

So since outputting raw HTML is a feature and covering all possible kinds of breaking content would be quite out of scope, I'm closing this as wont-fix

Note that adding a special case for <body> would be relatively useless imo, it's rare you even see that in docs