Finish API documentation

[vickumar1981]

Need to put annotated comments in more files. The docs are incomplete and could use more explanation of what each of the methods and parameters do.

[ghost]

hi there. I'd like to pitch in and help your community with documentation support if possible.

[vickumar1981]

@reneleft01 thanks.

to run the docs you use: sbt doc, assuming you have sbt setup - https://www.scala-sbt.org/1.0/docs/Setup.html

there's only a few places where the documentation is okay, but even there it can be improved:

https://github.com/vickumar1981/stringdistance/blob/master/src/main/scala/com/github/vickumar1981/stringdistance/package.scala#L7

https://github.com/vickumar1981/stringdistance/blob/master/src/main/scala/com/github/vickumar1981/stringdistance/StringDistance.scala#L6

https://github.com/vickumar1981/stringdistance/blob/master/src/main/scala/com/github/vickumar1981/stringdistance/StringSound.scala#L6

Everywhere else, documentation is needed, and particularly for the Java interface and the implementations.

[rjseymour66]

Hi All, Do you still need help with the documentation? I didn't see that this issue is closed.

I am a professional technical writer and would like to assist, if that is still needed.

[vickumar1981]

Hi @rjseymour66 .

Definitely still need help with the documentation. The repo is using scaladocs: https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html . Please feel free to shoot me an email or DM me on Twitter, vickumar1981. Thank you also.

[rjseymour66]

Great! I will take a closer look over the weekend and respond with any questions/suggestions.

[vickumar1981]

Started working on the documentation: https://github.com/vickumar1981/stringdistance/pull/18

Basic usage of scala docs:

• https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html
• https://docs.scala-lang.org/style/scaladoc.html

[vickumar1981]

Until the CONTRIBUTING.md is complete,here's the general instructions for working with the documentation:

1) Need java 8 installed - https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html 3) Clone the repo, specifically checkout the snapshot branch (currently, 1.0.8-SNAPSHOT) 4) Run ./sbt doc 5) The index.html file for the docs will be generated under target/scala-2.12/api

[vickumar1981]

Closing and creating separate issues per top level package:

https://github.com/vickumar1981/stringdistance/issues/30 https://github.com/vickumar1981/stringdistance/issues/31 https://github.com/vickumar1981/stringdistance/issues/32 https://github.com/vickumar1981/stringdistance/issues/33 https://github.com/vickumar1981/stringdistance/issues/34