@alias in scaladoc

Channing

unread,

Apr 11, 2012, 11:59:32 AM4/11/12

to scala-...@googlegroups.com

Quite often we hear of people being confused by symbolic method names in scala, even though the scaladoc might include references to equivalent methods with more conventional names. eg. scalaz's MA has a number of examples of this.

So, how about adding an '@alias method' to scaladoc to enable IDE's and scaladoc to automatically provide helpful info for symbolic methods?

eg.

/** @alias map */
def ∘[B](f: A => B)(implicit t: Functor[M]): M[B] = map(f)

√iktor Ҡlang

unread,

Apr 11, 2012, 12:09:40 PM4/11/12

to Channing, scala-...@googlegroups.com

I've thought about this myself, and I really think it's better off as a real annotation.

Cheers,

√

--
Viktor Klang

Akka Tech Lead

Typesafe - The software stack for applications that scale

Twitter: @viktorklang

wookietreiber

unread,

Apr 11, 2012, 1:48:04 PM4/11/12

to scala-...@googlegroups.com

I suggested that a while ago:

https://groups.google.com/group/scala-language/browse_thread/thread/28879fa2f6e70b57/bebd076ac56c5cef?#bebd076ac56c5cef

--

Beste Grüße / Best Regards
Christian Krause aka wookietreiber

-----------------------------------------------------------------------

Egal wie dicht du bist, Goethe war Dichter.

Daniel Sobral

unread,

Apr 11, 2012, 1:49:05 PM4/11/12

to Channing, scala-...@googlegroups.com

Why not use @see for that? MMmm.... Except, of course, that we (still)
cannot link to members, just type members. Fix that, and we can
improve the documentation in many, many ways.

--
Daniel C. Sobral

I travel to the future all the time.