Menu
I have a Scala project under sbt. I'd like to generate a javadoc for it as most of the users of the project API are Java developers. Is this possible?
742
Step 1 − Open eclipse, select the option Project →Generate Javadoc. Step 2 − Select the javadoc.exe file from the bin folder of java installation directory, select the destination folder for the generated java doc and select Next. finish button.
In the Package Explorer view, select a Java project and click Project > Generate Javadoc with Diagrams > Automatically. In the Generate Javadoc wizard, under Javadoc command, select the Javadoc command (an executable file).
In Eclipse, go to File > Export. Expand Java and select Javadoc. Then click Next. Select your project and package.
JavaDoc tool is a document generator tool in Java programming language for generating standard documentation in HTML format. It generates API documentation. It parses the declarations ad documentation in a set of source file describing classes, methods, constructors, and fields.
I assume that you want your docs in JavaDoc format in order to have something familiar to people that are used to java libraries?
There is a project from typesafe called GenJavaDoc that might be what you are looking for. It generates docs for a scala library in a format that is very similar to javadoc. It can be integrated into an sbt build.
Akka has a very complete java api, and many of the users of Akka come from the java world, so obviously they have a need for this.
The project repository
Akka japi docs generated by the tool
Blog post by Roland Kuhn describing the tool and the rationale
88
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
