Commit c50d4573 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Merge branch 'master' into doc-tags

parents 97a98209 785fbe32

README.md

+6 −12
Original line number Diff line number Diff line
@@ -11,8 +11,8 @@ the old [ext-doc][] was. It is used by Sencha to document [Ext JS 
products.



The highlights of JSDuck are [Markdown][] support and keeping you DRY

by inferring a lot of information from code.  Read the [Guide][] for

full overview.

by inferring a lot of information from code.  Read the

[documentation][] for full overview.



**New to JSDuck?** Watch [introductory talk by Nick Poulden][video]:
@@ -23,8 +23,8 @@ full overview. 
[Markdown]: http://daringfireball.net/projects/markdown/

[ext4-docs]: http://docs.sencha.com/ext-js/4-0/

[touch2-docs]: http://docs.sencha.com/touch/2-0/

[other-docs]: http://docs.sencha.com/ext-js/4-0/

[Guide]: https://github.com/senchalabs/jsduck/wiki/Guide

[other-docs]: http://docs.sencha.com/

[documentation]: https://github.com/senchalabs/jsduck/wiki

[video]: http://vimeo.com/33465319



Getting it
@@ -112,21 +112,15 @@ directories: 
Note that the resulting documentation will only contain the API

documentation.  Guides, videos and examples will not be present.

These can be added using more command line options as explained in the

[Advanced Usage][adv] section of wiki.



[adv]: https://github.com/senchalabs/jsduck/wiki/Advanced-Usage

[documentation][].





Documenting your code

---------------------



For quick overview read the [Guide][] and take a look at [example.js][example].

Follow links in the guide to digg into the details.



Looking for specific @tag? Take a look at the [whole list of supported tags][tags].

Read the [documentation][] and take a look at [example.js][example].



[example]: https://github.com/senchalabs/jsduck/blob/master/opt/example.js

[tags]: https://github.com/senchalabs/jsduck/wiki/Tags





Hacking it

jsduck.gemspec

+2 −2
Original line number Diff line number Diff line
@@ -2,8 +2,8 @@ Gem::Specification.new do |s| 
  s.required_rubygems_version = ">= 1.3.5"



  s.name = 'jsduck'

  s.version = '4.6.1'

  s.date = '2013-01-17'

  s.version = '4.6.2'

  s.date = '2013-02-25'

  s.summary = "Simple JavaScript Duckumentation generator"

  s.description = "Documentation generator for Sencha JS frameworks"

  s.homepage = "https://github.com/senchalabs/jsduck"

lib/jsduck/options.rb

+1 −1
Original line number Diff line number Diff line
@@ -91,7 +91,7 @@ module JsDuck 
      ]

      @ext4_events = nil



      @version = "4.6.1"

      @version = "4.6.2"



      # Customizing output

      @title = "Documentation - JSDuck"