JavaDoc is (traditionally) HTML-based. We need to enhance the DocCommentCreator/DocInlineCreator types with some kind of HTML generation (using the same borrow pattern for tag content). This will allow for the addition of things like images, external links, ordered and unordered lists, etc.
Not all HTML tags are allowed in doc comments, and even fewer would be allowed in an inline context. Some HTML tags are void elements and thus do not have content. Other HTML tags have other restrictions. Block JavaDoc tags are not allowed within HTML tags which have bodies. The API must take all of this into account by creating appropriate levels to the doc interface hierarchy representing the content restrictions of each context.
JavaDoc is (traditionally) HTML-based. We need to enhance the
DocCommentCreator/DocInlineCreatortypes with some kind of HTML generation (using the same borrow pattern for tag content). This will allow for the addition of things like images, external links, ordered and unordered lists, etc.Not all HTML tags are allowed in doc comments, and even fewer would be allowed in an inline context. Some HTML tags are
voidelements and thus do not have content. Other HTML tags have other restrictions. Block JavaDoc tags are not allowed within HTML tags which have bodies. The API must take all of this into account by creating appropriate levels to the doc interface hierarchy representing the content restrictions of each context.