Skip to content

Investigate support for more javadoc html tags #2262

@IgnatBeresnev

Description

@IgnatBeresnev

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 for MarkdownTokenTypes.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:

  1. Investigate which tags already have render support (like br and strike) or where very little work is needed
  2. 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.
  3. 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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementAn issue for a feature or an overall improvementformat: JavadocAn issue/PR related to Dokka's Javadoc output format or the Javadoc comments in generallanguage: JavaIssue/PR related to the Java language feature/analysis/docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions