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

Rake task for documenting the Docs app itself. 

Added some missing doc-comments.
parent af8fe3a8

Rakefile

+26 −6
Original line number Diff line number Diff line
@@ -20,8 +20,7 @@ task :install => :build do 
  system "gem install --user-install jsduck"

end



desc "Run JSDuck on ExtJS SDK"

task :sdk do

def load_sdk_vars

  if File.exists?("sdk-vars.rb")

    require "sdk-vars.rb"

  else
@@ -35,7 +34,9 @@ task :sdk do 
    puts "    OUT_DIR='/path/to/ouput/dir'"

    exit 1

  end

end



def run_jsduck(paths)

  system [

    "ruby bin/jsduck",

    # --external=Error to ignore the Error class that Ext.Error extends.
@@ -49,14 +50,33 @@ task :sdk do 
    '--img=\'<p><img src="doc-resources/%u" alt="%a"></p>\'',

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

    "--output=#{OUT_DIR}",

    "#{SDK_DIR}/extjs/src",

    "#{SDK_DIR}/platform/src",

    "#{SDK_DIR}/platform/core/src"

  ].join(" ")

  ].concat(paths).join(" ")



  # Finally copy over the images that documentation links to.

  system "cp -r #{SDK_DIR}/extjs/doc-resources #{OUT_DIR}/doc-resources"

  system "cp -r #{SDK_DIR}/platform/doc-resources/* #{OUT_DIR}/doc-resources"

end



desc "Run JSDuck on ExtJS SDK"

task :sdk do

  load_sdk_vars

  run_jsduck([

    "#{SDK_DIR}/extjs/src",

    "#{SDK_DIR}/platform/src",

    "#{SDK_DIR}/platform/core/src",

  ])

end



desc "Run JSDuck on the Docs app itself"

task :docs do

  load_sdk_vars

  run_jsduck([

    "#{SDK_DIR}/extjs/src",

    "#{SDK_DIR}/platform/src",

    "#{SDK_DIR}/platform/core/src",

    "template/app",

    "template/app.js",

  ])

end



task :default => :spec

template/app.js

+3 −0
Original line number Diff line number Diff line 
/**

 * @class Docs.App

 * @extends Ext.app.Application

 *

 * Main application definition for Docs app. Defines a 'Docs' namespace under

 * which all models, views, controllers, stores, helpers etc should be defined.

 */

template/app/controller/Search.js

+3 −0
Original line number Diff line number Diff line 
/**

 * Controller for search.

 */

Ext.define('Docs.controller.Search', {

    extend: 'Ext.app.Controller',

template/app/store/Search.js

+3 −0
Original line number Diff line number Diff line 
/**

 * Store for keeping search results.

 */

Ext.define('Docs.store.Search', {

    extend: 'Ext.data.Store',

template/app/view/search/Dropdown.js

+3 −0
Original line number Diff line number Diff line 
/**

 * Renders search results list.

 */

Ext.define('Docs.view.search.Dropdown', {

    extend: 'Ext.view.View',

    alias: 'widget.searchdropdown',