scaladoc: @link

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

scaladoc: @link

Florian Hof
I'm creating a documentation with help of scaladoc.
Since I cannot find a documentation, I use the same syntax as javadoc.
But I've problems with links, following the model:

    {@link  package.class#member  label}

When calling scaladoc I get the following warnings (and lots of
similar):

    Warning: not found Tag(@link, #id identifier)
    Warning: not found Tag(@link, main(Array[String]) main)

Otherwise, pages are generated and everything else seems to be fine. Is
the @link tag supported by scaladoc? Is Has anyone experiences about
scaladoc, especially @link?

Thanks,
Florian

Reply | Threaded
Open this post in threaded view
|

Re: scaladoc: @link

Stéphane Micheloud
Supported tags by scaladoc are:

   @author
   @ignore
   @label
   @param
   @return
   @see
   @since
   @version


See source in SVN repository:

http://scalasvn.epfl.ch/cgi-bin/viewvc.cgi/scala/branches/old-scala/sources/scala/tools/scaladoc/HTMLGenerator.java?view=markup


Bye
--S. Micheloud


Florian Hof wrote:

> I'm creating a documentation with help of scaladoc.
> Since I cannot find a documentation, I use the same syntax as javadoc.
> But I've problems with links, following the model:
>
>    {@link  package.class#member  label}
>
> When calling scaladoc I get the following warnings (and lots of similar):
>
>    Warning: not found Tag(@link, #id identifier)
>    Warning: not found Tag(@link, main(Array[String]) main)
>
> Otherwise, pages are generated and everything else seems to be fine. Is
> the @link tag supported by scaladoc? Is Has anyone experiences about
> scaladoc, especially @link?
>
> Thanks,
> Florian
>