Module: JsdocHelper

Defined in:
lib/jsdoc_helper.rb,
lib/jsdoc_helper/rake/task.rb,
lib/jsdoc_helper/rake/task/runner.rb

Defined Under Namespace

Modules: Rake

Constant Summary collapse

VERSION =

:stopdoc:

'0.0.2'
LIBPATH =
::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH =
::File.dirname(LIBPATH) + ::File::SEPARATOR

Class Method Summary collapse

Class Method Details

.libpath(*args) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



19
20
21
# File 'lib/jsdoc_helper.rb', line 19

def self.libpath( *args )
  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
end

.path(*args) ⇒ Object

Returns the path for the module. If any arguments are given, they will be joined to the end of the path using File.join.



27
28
29
# File 'lib/jsdoc_helper.rb', line 27

def self.path( *args )
  args.empty? ? PATH : ::File.join(PATH, args.flatten)
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to require all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



36
37
38
39
40
41
42
# File 'lib/jsdoc_helper.rb', line 36

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= ::File.basename(fname, '.*')
  search_me = ::File.expand_path(
      ::File.join(::File.dirname(fname), dir, '**', '*.rb'))

  Dir.glob(search_me).sort.each {|rb| require rb}
end

.versionObject

Returns the version string for the library.



11
12
13
# File 'lib/jsdoc_helper.rb', line 11

def self.version
  VERSION
end