-
Notifications
You must be signed in to change notification settings - Fork 481
Open
Labels
enhancementAn issue for a feature or an overall improvementAn issue for a feature or an overall improvementformat: JavadocAn issue/PR related to Dokka's Javadoc output format or the Javadoc comments in generalAn issue/PR related to Dokka's Javadoc output format or the Javadoc comments in generallanguage: JavaIssue/PR related to the Java language feature/analysis/docsIssue/PR related to the Java language feature/analysis/docs
Description
At the moment, there's inconsistency and confusion when it comes to javadoc html tags support
There are basically 3 kinds of tags atm:
- Those we support natively (we fully parse & custom render it)
- Those we don't parse, but can render. For instance, tag
<br>is not parsed and is therefore lost, but we have support for it internally (same implementation as forMarkdownTokenTypes.HARD_LINE_BREAK). Same for strikethrough. These should be simple fixes - Those we don't support at all. They and their children get lost and an empty text tag is returned.
Proposal:
- Investigate which tags already have render support (like
brandstrike) or where very little work is needed - Create a list of tags that don't have any support, try to sort it in order of importance/frequency of use. Some of these should probably be implemented as separate issues.
- Investigate whether it's possible to render unsupported html tags the same way it's rendered for kotlin (through passing raw html text with a certain content type).
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementAn issue for a feature or an overall improvementAn issue for a feature or an overall improvementformat: JavadocAn issue/PR related to Dokka's Javadoc output format or the Javadoc comments in generalAn issue/PR related to Dokka's Javadoc output format or the Javadoc comments in generallanguage: JavaIssue/PR related to the Java language feature/analysis/docsIssue/PR related to the Java language feature/analysis/docs