Class: JsDoc

Inherits:
Object
  • Object
show all
Defined in:
lib/jsdoc.rb

Constant Summary collapse

JSDOC_VERSION = 
'2.4.0'
JAVA_EXECUTABLE = 
'java'
JSDOC_DIR_PREFIX = 
'jsdoc-toolkit'
S = 
File::SEPARATOR
DEFAULT_JSDOC_DIR = 
File.expand_path(File.dirname(__FILE__) + S + JSDOC_DIR_PREFIX + '-' + JSDOC_VERSION)
DEFAULT_JSDOC_TEMPLATE_DIR = 
File.expand_path(DEFAULT_JSDOC_DIR + S + 'templates' + S + 'jsdoc')

Instance Method Summary collapse

Constructor Details

#initialize(jsdoc_dir = DEFAULT_JSDOC_DIR, jsdoc_template_dir = DEFAULT_JSDOC_TEMPLATE_DIR) ⇒ JsDoc

Returns a new instance of JsDoc.



9
10
11
12
 
# File 'lib/jsdoc.rb', line 9

def initialize(jsdoc_dir = DEFAULT_JSDOC_DIR, jsdoc_template_dir = DEFAULT_JSDOC_TEMPLATE_DIR)
  @jsdoc_dir = jsdoc_dir
  @jsdoc_template_dir = jsdoc_template_dir
end

Instance Method Details

#run(output_dir, *rest) ⇒ Object 



14
15
16
17
18
19
20
21
22
 
# File 'lib/jsdoc.rb', line 14

def run(output_dir, *rest)
  args = %W(-Djsdoc.dir=#{@jsdoc_dir}
            -Djsdoc.template.dir=#{@jsdoc_template_dir}
            -jar #{@jsdoc_dir}#{S}jsrun.jar
            #{@jsdoc_dir}#{S}app#{S}run.js
            -t=#{@jsdoc_template_dir}
            -d=#{output_dir}) + rest
  system(JAVA_EXECUTABLE, *args)
end