Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Javadoc Formatting #6

Open
rheitjoh opened this issue Nov 17, 2020 · 0 comments
Open

Improve Javadoc Formatting #6

rheitjoh opened this issue Nov 17, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@rheitjoh
Copy link
Member

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.

@rheitjoh rheitjoh added the enhancement New feature or request label Nov 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant