Commit 126d9fe3 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Sensible defaults to @img and @link templates.

parent 6b1ed263

Rakefile

+0 −4
Original line number Diff line number Diff line
@@ -43,10 +43,6 @@ def run_jsduck(extra_options) 
    "ruby", "bin/jsduck",

    # --external=Error to ignore the Error class that Ext.Error extends.

    "--external", "Error",

    '--link', '<a href="#/api/%c%-%m" rel="%c%-%m" class="docClass">%a</a>',

    # Note that we wrap image template inside <p> because {@img} often

    # appears inline within text, but that just looks ugly in HTML

    '--img', '<p><img src="doc-resources/%u" alt="%a"></p>',

    "--guides", "#{SDK_DIR}/guides",

    "--guides-order", "getting,class,application,layouts,data,grid,tree,drawing,forms,components,theming,direct",

    "--categories", "#{SDK_DIR}/extjs/doc-resources/categories.json",

bin/jsduck

+2 −2
Original line number Diff line number Diff line
@@ -82,7 +82,7 @@ opts = OptionParser.new do | opts | 
    "Possible placeholders:",

    "%u - URL from @img tag (e.g. 'some/path.png')",

    "%a - alt text for image",

    "Default value in export: '<img src=\"%u\" alt=\"%a\"/>'", " ") do |tpl|

    "Default is: '<p><img src=\"doc-resources/%u\" alt=\"%a\"></p>'", " ") do |tpl|

    app.img_tpl = tpl

  end
@@ -99,7 +99,7 @@ opts = OptionParser.new do | opts | 
    "%# - inserts '#' if member name present",

    "%- - inserts '-' if member name present",

    "%a - anchor text for link",

    "Default value in export: '<a href=\"%c%#%m\">%a</a>'", " ") do |tpl|

    "Default is: '<a href=\"#/api/%c%-%m\" rel=\"%c%-%m\" class=\"docClass\">%a</a>'", " ") do |tpl|

    app.link_tpl = tpl

  end

lib/jsduck/app.rb

+6 −0
Original line number Diff line number Diff line
@@ -83,6 +83,12 @@ module JsDuck 


    # Call this after input parameters set

    def run

      # Set default templates

      @link_tpl ||= '<a href="#/api/%c%-%m" rel="%c%-%m" class="docClass">%a</a>'

      # Note that we wrap image template inside <p> because {@img} often

      # appears inline within text, but that just looks ugly in HTML

      @img_tpl ||= '<p><img src="doc-resources/%u" alt="%a"></p>'



      parsed_files = @timer.time(:parsing) { parallel_parse(@input_files) }

      result = @timer.time(:aggregating) { aggregate(parsed_files) }

      relations = @timer.time(:aggregating) { filter_classes(result) }