Is is possible to reference function's parameter in the documention text?

Question

I woul like to reference method's parameters in the documentation text, but have no idea how to do it.
In .NET world we use tag paramref

Just as an example:

/** Send email with the specified @paramref body to the addesses given in @paramref to.
@param body Just a plain text or teamplate-aware text.*/ 
def SendEmail(body: EmailBody, to: EmailAddress*) = ???

How is it done in Scala?

score 1 · Accepted Answer · answered Aug 25 '17 at 15:58

1

You can make reference in Scaladoc similarly to Javadoc. According to the documentation for javadocs:

{@code foo}

and

<code>foo</code>

But XML looks ugly and not readable, prefer to use {@code foo} instead.

answered Aug 25 '17 at 15:58

4

{@code foo} just formats "foo" as code. It's not a reference. – James Moore Oct 19 '20 at 20:21
{@link foo} to reference foo – Deepu May 15 '23 at 18:07

score -4 · Answer 2 · answered Aug 25 '17 at 11:22

-4

I think you should find everything you need in https://docs.scala-lang.org/style/scaladoc.html. Do a string search for "param name".

answered Aug 25 '17 at 11:22

Prasad Rao

21
1

This is just a style guide and not a comprehensive "how to write docs" guide. – Dirk Jun 24 '21 at 19:55

Is is possible to reference function's parameter in the documention text?

2 Answers2