Commit 3b457fbb authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Merge branch 'master' into esprima-parser

parents 3a6f61f3 3d9ec45e

README.md

+3 −0
Original line number Diff line number Diff line
@@ -41,7 +41,10 @@ For **Windows** users out there, you can download the binary version, 
which includes Ruby interpreter and all dependencies bundled in a

single .exe file.  Grab it from the [download page][].



If you are brave enough: [try out JSDuck 4.0 beta.][beta]



[download page]: https://github.com/senchalabs/jsduck/downloads

[beta]: https://github.com/senchalabs/jsduck/wiki/4.0-beta



Usage

-----

lib/jsduck/guides.rb

+11 −12
Original line number Diff line number Diff line
@@ -36,15 +36,13 @@ module JsDuck 
    end



    # Modified each_item that also loads HTML for each guide

    def each_item(&block)

      unless @loaded

    def each_item

      super do |guide|

          guide[:html] = load_guide(guide)

        # Load the guide if not loaded

        guide[:html] = load_guide(guide) if guide[:html] == nil

        # Pass guide to block if it was successfully loaded.

        yield guide if guide[:html]

      end

        @loaded = true

      end



      super(&block)

    end



    # Modified to_array that excludes the :html from guide nodes
@@ -60,12 +58,13 @@ module JsDuck 
    def load_guide(guide)

      in_dir = @path + "/guides/" + guide["name"]



      begin

      return Logger.instance.warn(:guide, "Guide #{in_dir} not found") unless File.exists?(in_dir)



      guide_file = in_dir + "/README.md"



      return Logger.instance.warn(:guide, "README.md not found in #{in_dir}") unless File.exists?(guide_file)



      begin

        @formatter.doc_context = {:filename => guide_file, :linenr => 0}

        name = File.basename(in_dir)

        @formatter.img_path = "guides/#{name}"

lib/jsduck/logger.rb

+2 −0
Original line number Diff line number Diff line
@@ -102,6 +102,8 @@ module JsDuck 
      elsif !@warnings.has_key?(type)

        warn(nil, "Unknown warning type #{type}")

      end



      return false

    end



    # Formats filename and line number for output

lib/jsduck/options.rb

+3 −3
Original line number Diff line number Diff line
@@ -79,8 +79,8 @@ module JsDuck 
      @version = "4.0.beta"



      # Customizing output

      @title = "Sencha Docs - Ext JS"

      @header = "<strong>Sencha Docs</strong> Ext JS"

      @title = "Ext JS - Sencha Docs"

      @header = "<strong>Ext JS</strong> Sencha Docs"

      @footer = "Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> #{@version}."

      @head_html = ""

      @body_html = ""
@@ -183,7 +183,7 @@ module JsDuck 


        opts.on('--title=TEXT',

          "Custom title text for the documentation.",

          "Defaults to 'Sencha Docs - Ext JS'", " ") do |text|

          "Defaults to 'Ext JS - Sencha Docs'", " ") do |text|

          @title = text

          @header = text.sub(/^(.*?) +- +/, "<strong>\\1 </strong>")

        end

opt/comments-server-side/package.json

+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ 
    "express": "git://github.com/visionmedia/express.git",

    "express-namespace": "",

    "connect": "",

    "connect-mongo": "",

    "connect-mongo": "0.1.7",

    "marked": "",

    "mongoose": "",

    "mysql": "",