[phpMyAdmin Developers] Documentation generator for JavaScript code

[Piyush Vijay]

Hi, community,

I and Deven were discussing about implementing the documentation
generator for documenting the JavaScript code.

So I had implemented JsDoc (http://usejsdoc.org/) with minami as the theme (
https://github.com/nijikokun/minami) for the same. The theme is implemented
only for the purpose of generating a sample documentation. It can be
changed at any point in time.
One of the documentation generated for the till now revamped code is hosted
on github for sampling. The link for the same is
https://piyush3079.github.io/pma-js-docs/

Although the documentation is not up to the mark as proper guidelines were
not used for the functions and variables but it can be improved by
attempting certain guidelines.

Looking forward to your suggestions regarding this.

Regards,
Piyush Vijay

[image: Mailtrack]
<https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality6&>
Sender
notified by
Mailtrack
<https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality6&>
13/08/18,
04:35:00
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.phpmyadmin.net/pipermail/developers/attachments/20180813/7765b01b/attachment.html>