Fix external links in Scaladocs. #82
Conversation
This addresses issue Comcast#41, by just taking the path of least resistance and just entering explicit URLs for the three external references we currently have.
|
👍 better than nothing |
| * | ||
| * Possible values include AES128CounterSecureRNG, AES256CounterSecureRNG, AES128CounterInetRNG, | ||
| * AES256CounterInetRNG, SHA1PRNG, NativePRNG. See [[akka.remote.transport.netty.NettySSLSupport]] for | ||
| * AES256CounterInetRNG, SHA1PRNG, NativePRNG. See [[http://doc.akka.io/japi/akka/2.2-M4/akka/remote/transport/netty/NettySSLSupport$.html akka.remote.transport.netty.NettySSLSupport]] for |
There was a problem hiding this comment.
That link doesn't give much help -- not a lot of details there. I might suggest https://github.com/akka/akka/blob/v2.2.1/akka-remote/src/main/scala/akka/remote/transport/netty/NettySSLSupport.scala instead, since you can actually dig through and see what's going on.
There was a problem hiding this comment.
My initial thought was that these should link to the apidocs, since that's where we're coming from. That said, I do see what you mean about it not being much help. Since these are links in a comment field, I'd suggest we just include both links, as well as perhaps http://doc.akka.io/docs/akka/snapshot/scala/remoting.html#SSL. As long as they are well annotated, an interested person can easily follow the link they want.
There was a problem hiding this comment.
Ha! Even better: the whole NettySSLSupport class doesn't even exist in 2.2.1. Also it appears that "NativePRNG" is no longer a supported option. I'm crafting an additional commit to point to the 2.2.1-specific reference configuration for akka remoting (an annotated config file).
There was a problem hiding this comment.
Hah, great. Hooray for documentation curation!
* Link specifically to Akka 2.2.1 apidocs for Agent. * Point to Akka 2.2.1 configuration docs, which are more useful than the (nonexistent in 2.2.1) NettySSLSupport class's apidocs. :)
|
Looks good. 👍 |
Fix external links in Scaladocs.
This addresses issue #41, by just taking the path of least
resistance and entering explicit URLs for the three
external references we currently have.