Question

When using auto-generated documentation for Google apps script libraries it’s possible to use the Google prettyprint class for code samples? I’ve tried including it in the pre tag:
<pre class="prettyprint">

but seems to get stripped out during the generation.

Is there also a way to use the @see command to reference functions or external resources inside the code documentation?

Answer 1

There are numerous limitations to the gsdoc tags supported by google-apps-script, and you’ve described just two of them – no support for html element attributes, and limited doc tags. I’ve described some other issues in How to preview jsdoc comments in google doc scripts.

There are also open issues:

• Preview jsDoc documentation from within the script editor
• Make it easier to show examples by supporting @example in Libraries
• Support Object Oriented Interfaces with documentation for Libraries

You could add a new issue for your particular concern. The @see tag is especially odd, since it appears used in the Base Services documentation, so either the tag works just for Google, or has html substituted for it.

One option is to build and host your documentation on another platform or hosting service. This is what has been done for some of the Notable Libaries, such as the 2D Array Library. Then, you can generate your docs using jsdoc, and employ the richness of the whole tag set.