Skip to content

Improve Javadoc Formatting #6

@rheitjoh

Description

@rheitjoh

I just rendered the math Javadoc and noticed that Javadoc does not support markdown type paragraph formatting, i.e. inserting an empty line between paragraphs. This leads to a lot of block of texts without any formatting applied. Instead, HTML tags such as <p> should be utilized.

Furthermore, code blocks should be formatted using the HTML tag <pre>, or the @code annotation for inline code.

We should take a look over the Javadoc and fix any such issues before the next release.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions