class Packnga::DocumentTask
@since 0.9.0
They generate YARD document or references.
This class creates tasks for document.
def base_dir=(dir)
-
dir
(String
) -- base direcory path
def base_dir=(dir) dir = Pathname.new(dir) @yard_task.base_dir = dir @reference_task.base_dir = dir end
def c_source_file?(file)
def c_source_file?(file) file.start_with?("ext/") and file.end_with?(".c") end
def define
def define set_default_values define_tasks end
def define_tasks
def define_tasks @yard_task.define @reference_task.define end
def initialize(spec)
-
spec
(Gem::Specification
) -- specification for your package
def initialize(spec) @spec = spec @yard_task = YARDTask.new(@spec) @reference_task = ReferenceTask.new(@spec) self.base_dir = "doc" yield(self) if block_given? define end
def original_language=(language)
- Since: - 0.9.6
Parameters:
-
language
(String
) -- language you wrote document
Other tags:
- See: DocumentTask#translate_languages= - #translate_language(s)= is used to specify languages for translation.
def original_language=(language) @reference_task.original_language = language end
def reference
def reference yield(@reference_task) end
def ruby_source_file?(file)
def ruby_source_file?(file) file.start_with?("lib/") and file.end_with?(".rb") end
def set_default_readme
def set_default_readme readme = @spec.files.find do |file| file.include?("README") end return if readme.nil? @yard_task.readme = readme @reference_task.readme = readme end
def set_default_source_files
def set_default_source_files source_files = @spec.files.find_all do |file| ruby_source_file?(file) or c_source_file?(file) end @yard_task.source_files = source_files @reference_task.source_files = source_files end
def set_default_text_files
def set_default_text_files text_dir = @yard_task.base_dir + "text" text_files = @spec.files.find_all do |file| file.start_with?(text_dir.to_s) end @yard_task.text_files = text_files @reference_task.text_files = text_files end
def set_default_values
def set_default_values set_default_readme set_default_source_files set_default_text_files end
def translate_language=(language)
- Since: - 0.9.7
Parameters:
-
language
(String
) -- target language code for translated document
Other tags:
- See: DocumentTask#translate_languages= -
See: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes -
Other tags:
- Example: Specify Japanese. -
def translate_language=(language) self.translate_languages = [language] end
def translate_languages=(languages)
- Since: - 0.9.6
Parameters:
-
languages
(Array
) --
Other tags:
- See: DocumentTask#translate_language= -
See: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes -
Other tags:
- Example: Sets Japanese and English. -
def translate_languages=(languages) @reference_task.translate_languages = languages end
def yard
def yard yield(@yard_task) end