Class: Packnga::DocumentTask — packnga - ラングバ

Class: Packnga::DocumentTask

Inherits:
Object
  • Object
show all
Includes:
Rake::DSL
Defined in:
lib/packnga/document-task.rb

Overview

このクラスはドキュメント関連のタスクを生成します。 これらタスクはYARDを使ってドキュメントやリファレンスを作成します。

Since:

  • 0.9.0

Instance Method Summary collapse

Constructor Details

#initialize(spec) {|_self| ... } ⇒ DocumentTask

YARDによるドキュメントを生成したりリファレンスを翻訳するタスクを定義します。

Parameters:

  • spec (Gem::Specification) —

    specification for your package

Yields:

  • (_self)

Yield Parameters:

Since:

  • 0.9.0



33
34
35
36
37
38
39
40
 
# File 'lib/packnga/document-task.rb', line 33

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

Instance Method Details

#base_dir=(dir) ⇒ Object

ドキュメントのベースとなるディレクトリを設定します。デフォルトの値は"doc"です

Parameters:

  • dir (String) —

    base direcory path

Since:

  • 0.9.0



44
45
46
47
48
 
# File 'lib/packnga/document-task.rb', line 44

def base_dir=(dir)
  dir = Pathname.new(dir)
  @yard_task.base_dir = dir
  @reference_task.base_dir = dir
end

#original_language=(language) ⇒ Object

ドキュメントを書いた元の言語を指定します。 デフォルトは"en"（英語）です。 この値は翻訳するための言語を決めるのに使います。

Parameters:

  • language (String) —

    language you wrote document

See Also:

Since:

  • 0.9.6



58
59
60
 
# File 'lib/packnga/document-task.rb', line 58

def original_language=(language)
  @reference_task.original_language = language
end

#reference {|@reference_task| ... } ⇒ Object

与えられた場合はブロックを実行して、リファレンス関連のタスクに関する設定をします。

Yields:

  • (@reference_task)

Since:

  • 0.9.0



116
117
118
 
# File 'lib/packnga/document-task.rb', line 116

def reference
  yield(@reference_task)
end

#translate_language=(language) ⇒ Object

ドキュメントを翻訳する言語を1つ指定します。 このメソッドは言語コードを示す文字列を受け取ります。

元のドキュメントが英語でなければ英語（"en"）がデフォルトで指定されます。英語の場合は何も指定されません。

Examples:

Specify Japanese.

DocumentTask.new(spec) do |task|
  task.translate_language = "ja"
end

Parameters:

  • language (String) —

    target language code for translated document

See Also:

Since:

  • 0.9.7



83
84
85
 
# File 'lib/packnga/document-task.rb', line 83

def translate_language=(language)
  self.translate_languages = [language]
end

#translate_languages=(languages) ⇒ Object

ドキュメントを翻訳する言語を1つ指定します。 このメソッドは言語コードを示す文字列を受け取ります。

元のドキュメントが英語でなければ英語（"en"）がデフォルトで指定されます。英語の場合は何も指定されません。

Examples:

Sets Japanese and English.

DocumentTask.new(spec) do |task|
  task.translate_languages = ["ja", "en"]
end

Parameters:

  • languages (Array<String>) —

    target language codes for translated document

See Also:

Since:

  • 0.9.6



106
107
108
 
# File 'lib/packnga/document-task.rb', line 106

def translate_languages=(languages)
  @reference_task.translate_languages = languages
end

#yard {|@yard_task| ... } ⇒ Object

与えられた場合はブロックを実行して、YARDによるドキュメントのためのタスクに関する設定をします。

Yields:

  • (@yard_task)

Since:

  • 0.9.0



111
112
113
 
# File 'lib/packnga/document-task.rb', line 111

def yard
  yield(@yard_task)
end