Documenting with JSDuck

  • 4,977 views
Uploaded on

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 …

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.

More in: Technology
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
  • Not really a helpful comment, considering the slides are just title cards
    Are you sure you want to
    Your message goes here
  • Not really helpful, considering the slides are just title cards.
    Are you sure you want to
    Your message goes here
    Be the first to like this
No Downloads

Views

Total Views
4,977
On Slideshare
0
From Embeds
0
Number of Embeds
1

Actions

Shares
Downloads
23
Comments
2
Likes
0

Embeds 0

No embeds

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
    No notes for slide

Transcript

  • 1. Wednesday, November 2, 2011
  • 2. Documenting with jsduck Nick Poulden, Sencha @nick_p Tuesday 25th October, 2011 Zombies by @jayrobinsonWednesday, November 2, 2011
  • 3. Why Document?Wednesday, November 2, 2011
  • 4. TodayWednesday, November 2, 2011
  • 5. Today JSDuck App (10 mins) Using JSDuck (30 mins) Questions (5 mins)Wednesday, November 2, 2011
  • 6. JSDuck Live DemoWednesday, November 2, 2011
  • 7. JSDuck TutorialWednesday, November 2, 2011
  • 8. Use JSDuck! sudo gem install jsduck github.com/senchalabs/jsduckWednesday, November 2, 2011