jsdoc tool itself.
jsdoc or a similar tool using npm.
npm install -g jsdoc
Generating Documentation for Installed Gems
Create a directory for the generated documentation within your application.
cd path/to/your_app mkdir docs
/docs, which was created above.
The commands above generate static HTML files. Open
index.html to browser the documentation.
Note: Avoid using undocumented Workarea functions and properties. They should be considered private and unstable.
Use similar commands to generate documentation for any Workarea plugins or additional gems.
Note: You may want to commit the documentation files into your application's code repository to save your teammates the trouble of generating their own documentation. Conversly, you may want to instruct your version control system to ignore these directories to force developers to generate fresh documentation each time.
How'd We Do?
Was this article missing something?
Was it not quite what you were looking for?
Do you have suggestions on how we could improve this article or your experience in general?
If so, please take a moment to let us know!
Your invaluable feedback will help everyone better understand the platform!