Jsdoc documentation entry on methods inside a class
I am writing several libraries in Google Apps Script and I am trying to document them. I wrote several classes in the following format, and the comments of the methods inside the class do not appear in the documentation:
/**
* My comments here
*/
function MyBeautifulObject(){
this.myMethod=myMethod;
....
/**
* This comment doesn't show up
*/
function myMethod(){
...
}
}
Any idea on how I can achieve this?
source to share
This question may be a duplicate ... this answer is definitely there .
The jsdoc variant supported for Libraries in Google Apps Script does not support documentation at the level you are looking for, only first level functions. There is a related bug report on this , but no response from Google.
You can still write jsdoc tags and build your documentation outside of google framework. Take a look at How to view jsdoc comments in google doc scripts for some pointers on how to view jsdoc comments. You can draw a conclusion jsdoc3
and publish it on the site to submit your documents to the community.
Other actual / possible duplicate messages:
source to share