Documentate private class/method/variable with Scaladoc

411 views
Skip to first unread message

AG

unread,
Jan 13, 2016, 11:38:08 AM1/13/16
to scala-user

Hello everyone,


So, I have an apparently simple question but I can't find the answer for it.


If I want to do the Scaladoc documentation of, let's say, a private class...how can I do it?


I think Scaladoc HAD an option long ago (--access), but it's no longer supported, so I suppose there must be an other way to do this.


I'm using Maven with my Scala projects, but it wouldn't be a problem if you help me using SBT commands


Thank you!

som-snytt

unread,
Jan 15, 2016, 1:10:42 PM1/15/16
to scala-user

There is an issue https://issues.scala-lang.org/browse/SI-3807

If your project has Scaladoc for its public members, you are already very blessed.

AG

unread,
Jan 17, 2016, 6:13:55 AM1/17/16
to scala-user
Thanks for your reply.

I new about that issue, it just seem strange to me that, a task marked as "high priority task" was still to be done 5 years after the issue was created. That's why I supposed there was a way to do this

Vlad Ureche

unread,
Jan 18, 2016, 3:15:13 AM1/18/16
to AG, Janek Bogucki, scala-user
It wouldn't be difficult to fix, but it's just one of those things nobody wanted very badly.
Janek, since you are very active in the scaladoc area, can you please have a look at it?

HTH,
Vlad


--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scala-user+...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply all
Reply to author
Forward
0 new messages