search

prismicio-community / scala-kit

Development kit for the Scala language
19 stars 26 forks source link

Better documentation of the Scala kit's API #9

Closed rudyrigot closed 10 years ago

rudyrigot commented 10 years ago

There is a ScalaDoc, but without comments or explanation.

zuriar commented 10 years ago

Also, it is currently only for build M5. does not reflect changes in M6-9

ornicar commented 10 years ago

I published the M10 kit, making many classes and functions private, so you don't have to worry about them. I added some scaladoc and generated API docs for M10: http://prismicio.github.io/scala-kit/#package

Note that when a function name and signature speak for themselves, no documentation was added. We're not using one of the more strongly typed languages on earth for nothing :)