class Murdoc::Languages::Base

Base language module

Any new language module should inherit from Base, redefine .extensions and .comment_symbols methods, if needed, and add itself to Languages.map map.

Public Class Methods

annotation_only?() click to toggle source
# File lib/murdoc/languages/base.rb, line 17
def self.annotation_only?
  false
end
applies_for?(filename) click to toggle source
# File lib/murdoc/languages/base.rb, line 9
def self.applies_for?(filename)
  if extensions.include?(File.extname(filename).sub(/^\./, ''))
    true
  else
    false
  end
end
comment_symbols() click to toggle source
# File lib/murdoc/languages/base.rb, line 25
def self.comment_symbols
  {
    single_line: nil,
    multiline: nil
  }
end
extensions() click to toggle source
# File lib/murdoc/languages/base.rb, line 21
def self.extensions
  []
end
name() click to toggle source
Calls superclass method
# File lib/murdoc/languages/base.rb, line 32
def self.name
  super.sub(/^(.*::)?([^:]+)$/, '\\2').
        gsub(/([a-z])([A-Z])/, '\\1_\\2').
        downcase.to_sym
end