Documentation of Open Food Facts Node Wrapper using jsdoc

in #utopian-io3 years ago (edited)

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

Sort:  

This post has been upvoted and picked by Daily Picked #4! Thank you for the cool and quality content. Keep going!

Don’t forget I’m not a robot. I explore, read, upvote and share manually :)

@ms10398 I am rejecting this contribution based on the fact that you are just making use of an auto-documenter, not actually providing added value by adding to the official documentation.

Not sure if this: http://thecodingninja.me/openfoodfacts-nodejs/openfoodfacts-nodejs/0.0.1/OFF.html was supposed to work, but at the time of checking it lead to a 404 page.

Thank you for the contribution. It has been approved.

You can contact us on Discord.
[utopian-moderator]

Hey @ms10398 I am @utopian-io. I have just upvoted you!

Achievements

  • You have less than 500 followers. Just gave you a gift to help you succeed!
  • Seems like you contribute quite often. AMAZING!

Community-Driven Witness!

I am the first and only Steem Community-Driven Witness. Participate on Discord. Lets GROW TOGETHER!

mooncryption-utopian-witness-gif

Up-vote this comment to grow my power and help Open Source contributions like this one. Want to chat? Join me on Discord https://discord.gg/Pc8HG9x

Hello, as a member of @steemdunk you have received a free courtesy boost! Steemdunk is an automated curation platform that is easy to use and built for the community. Join us at https://steemdunk.xyz

Upvote this comment to support the bot and increase your future rewards!

Congratulations @ms10398! You have completed some achievement on Steemit and have been rewarded with new badge(s) :

Award for the number of upvotes

Click on any badge to view your own Board of Honor on SteemitBoard.
For more information about SteemitBoard, click here

If you no longer want to receive notifications, reply to this comment with the word STOP

Upvote this notification to help all Steemit users. Learn why here!

Hello How r u Pls Vote me and follow me pls vote I have given u Already vote

Congratulations @ms10398! You have completed some achievement on Steemit and have been rewarded with new badge(s) :

Award for the number of upvotes

Click on any badge to view your own Board of Honor on SteemitBoard.
For more information about SteemitBoard, click here

If you no longer want to receive notifications, reply to this comment with the word STOP

Upvote this notification to help all Steemit users. Learn why here!