search

cryptimeleon / mclwrap

A wrapper to bring the mcl pairing library into cryptimeleon
BSD 3-Clause "New" or "Revised" License
3 stars 1 forks source link

Improve Javadoc Formatting #8

Closed rheitjoh closed 3 years ago

rheitjoh commented 3 years ago

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 commented 3 years ago

I think we fixed this a while ago...