asciidoctor / asciidoclet

:clipboard: A Javadoc Doclet based on Asciidoctor that lets you write Javadoc in the AsciiDoc syntax.
https://github.com/asciidoctor/asciidoclet
Apache License 2.0
133 stars 40 forks source link

Use of Javadoc annotations such as @link or @see #65

Closed mattadamson closed 5 years ago

mattadamson commented 6 years ago

Hi

How do others use previous JavaDoc annotation such as @link and @see in the Ascii doc formatted documentation? e.g. if we want to reference another class from a class definition we'd use

{@link classwithpackageidentifier}

Many thanks

Matt

johncarl81 commented 6 years ago

Asciidoclet will just enhance the tag's text, the annotation tags should work as they did before. For me, @see referencing a class within the same project will create a link to that class.

Myllyenko commented 5 years ago

@johncarl81 Is it possible to use @link inside a [source] block? The most straightforward approach:

 /**
  * [source,java]
  * --
  * {@link MyClass}
  * --
  */

doesn't work.

johncarl81 commented 5 years ago

Unfortunately, I don't have an answer for this use case @Myllyenko. Closest thing we support is a @see or @link tag outside of the source block.