Documenting with JSDuck

Post on 16-May-2015

5.059 views 1 download

Preview:

Click to see full reader

Tags:

Report this document

description

Documentation is an important part of any project, especially when there is an API to be exposed to other developers. JSDuck is an open source ExtJS 4 project developed at Sencha to help Javascript developers generate beautiful documentation viewable in a web browser. Based loosely on JavaDoc, JSDuck parses documentation embedded in the source files of your project enabling you to keep your docs close to your code. In this session we will cover the many features of JSDuck and by the end you will know how to create API documentation, guides, videos and examples for your own project or application.

Transcript of Documenting with JSDuck

Wednesday, November 2, 2011

Nick Poulden, Sencha

@nick_p

Documenting with jsduck

Zombies by @jayrobinson

Tuesday 25th October, 2011

Wednesday, November 2, 2011

Why Document?

Wednesday, November 2, 2011

Today

Wednesday, November 2, 2011

Today

JSDuck App (10 mins)Using JSDuck (30 mins)

Questions (5 mins)

Wednesday, November 2, 2011

JSDuck Live Demo

Wednesday, November 2, 2011

JSDuck Tutorial

Wednesday, November 2, 2011

Use JSDuck!

sudo gem install jsduck

github.com/senchalabs/jsduck

Wednesday, November 2, 2011

https://github.com/senchalabs/jsduck

https://github.com/senchalabs/jsduck

Copyright © 2022 FDOCUMENTS