[SOLVED] How do I generate Javadoc Style Documentation for SAHI scripts?

How do I generate Javadoc Style Documentation for SAHI scripts?

I have written all my tests using sahi-script, because it is the recommended way of working with this tool: https://sahipro.com/docs/using-sahi/recommended-usage.html#Language%20Recommendation

Now I need to do a documentation in Javadoc style and I tried to run Javadoc. I thought maybe, because: "The JS version can also call and reuse any Java code or libraries, so you can have the simplicity of JS but also use the power of Java when needed." it would work, but instead I got this:

>javadoc baum.sah
>Loading source files for package baum.sah...
>javadoc warning: No source files for package baum.sah
>Constructing Javadoc information...
>javadoc warning: No source files for package baum.sah
>javadoc error: No public or protected classes found to document.
>1 error
>2 warnings

My questions are:

1.) Is there any way to get a Javadoc style documentation without having to rewrite all the SAHI-script code in Java?

2.) If yes, how did you do it step by step?

Solution

Sahi code is in Javascript, well a wrapper over javascript. You can use jsdoc3 (https://github.com/jsdoc3/jsdoc) to generate javadoc style documentation for your sahi scripts. If you check in older versions of Sahi (around 5.2), there is a file called apis.sah where jsdoc3 style documentation is present.