Mohit Sharma avatar

Documentation of Open Food Facts Node Wrapper using jsdoc

ms10398

Published: 12 Mar 2018 › Updated: 12 Mar 2018Documentation of Open Food Facts Node Wrapper using jsdoc

Documentation of Open Food Facts Node Wrapper using jsdoc

Details

Recently developing Nodejs Wrapper for Open food facts. I tried out the JSDoc Comment structure and used it in documentation of the whole wrapper.

Components

I used JSdoc node module for documentation and published it using Github Pages.

You may see one of live version at this link

Diff

Before there was no documentation of the Node API Wrapper.

Links

You may check the Github repository here.

In the PR attached you may see the changes used for documenting the app.

Screenshots of the live deployed version are attached below -

Screenshot from 2018-03-12 19-59-15.png

Screenshot from 2018-03-12 19-59-24.png



Posted on Utopian.io - Rewarding Open Source Contributors

Leave Documentation of Open Food Facts Node Wrapper using jsdoc to:

Written by

Full Stack Web Developer | Utopian Community Manager

Read more #utopian-io posts


Best Posts From Mohit Sharma

We have not curated any of ms10398's posts yet. But you can encourage our curation team to review posts by visiting them regularly and by referring other readers. Because we give priority to frequently read content.

More Posts From Mohit Sharma