search

turtlemonvh / ionic-spark-utils

Utilities for working with Ionic encryption via Spark.
MIT License
0 stars 0 forks source link

Cleanup docs #16

Closed turtlemonvh closed 4 years ago

turtlemonvh commented 4 years ago

In addition to documentation in the README, I need to clean up the JavaDoc/ScalaDoc comments in the code so the generated documentation is cleaner.

Link to these generated docs on https://javadoc.io/ or similar.

turtlemonvh commented 4 years ago

I've been fiddling with this, esp. trying to get docs for java sources since most of the project is java code.

Unfortunately this is not possible until Scala 2.12:

I was thinking about breaking this down into a separate library for the java sources, and that is looking like a better option now.

r0bb23 commented 4 years ago

I've been fiddling with this, esp. trying to get docs for java sources since most of the project is java code.

Unfortunately this is not possible until Scala 2.12:

I was thinking about breaking this down into a separate library for the java sources, and that is looking like a better option now.

Hey Timothy, The newer versions of spark use Scala 2.12.

It was added experimentally in 2.4 and will be default in 3. I've switched my project over to it.

turtlemonvh commented 4 years ago

Ah ok cool - I'll try that then!

I was looking at this as an alternative: https://github.com/lightbend/genjavadoc

But honestly not excited about something with so many sbt options. I am trying to spend as little time as possible messing around with sbt. Every time I try to do something simple it seems to take hours to get it to behave.

r0bb23 commented 4 years ago

Yeah. Sbt is the personification of Scala. Hard to learn but great once you know it. I would still rather use sbt and Scala over any other choices in the Java world. Though I would also prefer just not to be the Java world.

turtlemonvh commented 4 years ago

The switch to 2.12 made this much easier (code on #22).

I need to fiddle around a bit more to make cross compiling behave, but since the code is the same for 2.11 and 2.12 (and Spark is recommending 2.12 now) I'm not going to fight with sbt to make the docs work on 2.11.

turtlemonvh commented 4 years ago

Docs for 0.0.2 published as part of #21 https://oss.sonatype.org/service/local/repositories/releases/archive/io/github/turtlemonvh/ionicsparkutils_2.12/0.0.2/ionicsparkutils_2.12-0.0.2-javadoc.jar/!/io/github/turtlemonvh/ionicsparkutils/index.html