class Jazzy::Doc

Public Instance Methods

docs_title() click to toggle source
# File lib/jazzy/doc.rb, line 45
def docs_title
  if config.title_configured
    config.title
  elsif config.version_configured
    # Fake version for integration tests
    version = ENV['JAZZY_FAKE_MODULE_VERSION'] || config.version
    "#{config.module_configs.first.module_name} #{version} Docs"
  else
    "#{config.module_configs.first.module_name} Docs"
  end
end
enable_katex() click to toggle source
# File lib/jazzy/doc.rb, line 57
def enable_katex
  Markdown.has_math
end
jazzy_version() click to toggle source
# File lib/jazzy/doc.rb, line 28
def jazzy_version
  # Fake version is used to keep integration tests consistent
  ENV['JAZZY_FAKE_VERSION'] || Jazzy::VERSION
end
language_stub() click to toggle source
# File lib/jazzy/doc.rb, line 37
def language_stub
  objc_first? ? 'objc' : 'swift'
end
module_version() click to toggle source
# File lib/jazzy/doc.rb, line 41
def module_version
  config.version_configured ? config.version : nil
end
objc_first?() click to toggle source
# File lib/jazzy/doc.rb, line 33
def objc_first?
  config.objc_mode && config.hide_declarations != 'objc'
end