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

Make sure @see works properly #69

Open
ktoso opened this issue Mar 16, 2016 · 1 comment
Open

Make sure @see works properly #69

ktoso opened this issue Mar 16, 2016 · 1 comment

Comments

@ktoso
Copy link
Contributor

ktoso commented Mar 16, 2016

And is really clickable

@ilx
Copy link
Contributor

ilx commented Jun 18, 2021

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>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants