Class/Module Index [+]

Quicksearch

YARD::CLI::I18n

CLI command to support internationalization (a.k.a. i18n). I18n feature is based on gettext technology. This command generates .pot file from docstring and extra documentation.

@since 0.8.0 @todo Support msgminit and msgmerge features?

Public Class Methods

new() click to toggle source
# File lib/yard/cli/i18n.rb, line 13
def initialize
  super
  @options.serializer.basepath = "po/yard.pot"
end

Public Instance Methods

description() click to toggle source
# File lib/yard/cli/i18n.rb, line 18
def description
  'Generates .pot file from source code and extra documentation'
end
run(*args) click to toggle source
# File lib/yard/cli/i18n.rb, line 22
def run(*args)
  if args.size == 0 || !args.first.nil?
    # fail early if arguments are not valid
    return unless parse_arguments(*args)
  end

  YARD.parse(files, excluded)

  serializer = options.serializer
  pot_file_path = Pathname.new(serializer.basepath).expand_path
  pot_file_dir_path, pot_file_basename = pot_file_path.split
  relative_base_path = Pathname.pwd.relative_path_from(pot_file_dir_path)
  serializer.basepath = pot_file_dir_path.to_s
  serializer.serialize(pot_file_basename.to_s,
                       generate_pot(relative_base_path.to_s))

  true
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.