Skip to content

Improve javadocs of native HTML element components #21749

Description

@stefanuebe

Describe your motivation

Flow provides a large set of components representing native HTML elements, like Div, Span, etc.

Those components partially play a significant role when building applications, e.g. Spans for text output.

While there is a docs page introducing these components, the components themselves are not very well documented (the javadocs just name the represented element) and require the dev to visit other pages like MDN to retrieve information about the intentional use of these components and other details.

Describe the solution you'd like

The javadocs of those HTML element components should provide basic necessary information regarding their intended usage, for instance:

The <main> HTML element represents the dominant content of the <body> of a document. The main content area consists of content that is directly related to or expands upon the central topic of a document, or the central functionality of an application.

(quoted from MDN)

It should also provide a link to the respective MDN page, which contains all necessary details for that element, e.g. https://developer.mozilla.org/de/docs/Web/HTML/Reference/Elements/main (could of course also link to other pages, but I think those are very well written in many cases and provide a lot of easy to understand examples)

Describe alternatives you've considered

Looking up the docs myself. But I assume, that is not done by every dev

Additional context

Fight for simplicity :)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions