genjavadoc icon indicating copy to clipboard operation
genjavadoc copied to clipboard

Make sure @see works properly

Open ktoso opened this issue 9 years ago • 1 comments

And is really clickable

ktoso avatar Mar 16 '16 09:03 ktoso

1st issue: See parses following declaration:

@see [[https://somewhere.com]] into prefix and link. In this case @see is prefix and https://somewhere.com is a link

and then it transforms it into:

@see <a href="https://somewhere.com" />

which javadoc does not like:

error: element not closed: a
   * @see <a href="https://www.postgresql.org/docs/9.5/index.html PostgreSql documentation"/>
                 ^

2nd issue: scaladoc also suggest:

@see [[https://somewhere.com Some human readable description]]

but this is not parsed by See in BaseCommments.scala at all

the only way to have a comment is to have something like:

@see <a href="https://db.apache.org/derby/docs/10.1/ref">https://db.apache.org/derby/docs/10.1/ref/</a>

ilx avatar Jun 18 '21 14:06 ilx