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

Class: Packnga::ReferenceTask

Inherits:
Object
  • Object
show all
Includes:
ERB::Util, Rake::DSL
Defined in:
lib/packnga/reference-task.rb,
lib/packnga/reference-task.rb

Overview

このクラスはリファレンス関係のタスクを生成します。これらタスクはリファレンスの生成や翻訳を行い、またリファレンスを公開するために必要な準備を行います。

Since:

  • 0.9.0

Instance Attribute Summary collapse

  • #base_dir ⇒ String

    この属性はドキュメントのベースディレクトリを表します。.
  • #original_language ⇒ String

    この属性はドキュメントが書かれた言語を指定します。デフォルト値は"en"（英語）です。.
  • #readme ⇒ String

    この属性はyardocに対して設定するReadmeファイルのパスを設定します。.
  • #source_files ⇒ Array<String>

    この属性はyardocに対して設定するソースファイルのパスを設定します。.
  • #text_files ⇒ Array<String>

    この属性はyardocに対して設定するテキストファイルのパスを設定します。.
  • #translate_languages ⇒ Array<String>

    この属性はドキュメントを翻訳する言語を指定します。元のドキュメントが英語でなければ英語（"en"）がデフォルトで指定されます。英語の場合は何も指定されません。.

Instance Attribute Details

#base_dir ⇒ String

この属性はドキュメントのベースディレクトリを表します。

Returns:

  • (String) —

    path of base directory of document

Since:

  • 0.9.0



36
37
38
 
# File 'lib/packnga/reference-task.rb', line 36

def base_dir
  @base_dir
end

#original_language ⇒ String

この属性はドキュメントが書かれた言語を指定します。デフォルト値は"en"（英語）です。

Returns:

  • (String) —

    language you used to write document

See Also:

Since:

  • 0.9.6



57
58
59
 
# File 'lib/packnga/reference-task.rb', line 57

def original_language
  @original_language
end

#readme ⇒ String

この属性はyardocに対して設定するReadmeファイルのパスを設定します。

Returns:

  • (String) —

    path of readme file

Since:

  • 0.9.0



40
41
42
 
# File 'lib/packnga/reference-task.rb', line 40

def readme
  @readme
end

#source_files ⇒ Array<String>

この属性はyardocに対して設定するソースファイルのパスを設定します。

Returns:

  • (Array<String>) —

    target source files

Since:

  • 0.9.0



44
45
46
 
# File 'lib/packnga/reference-task.rb', line 44

def source_files
  @source_files
end

#text_files ⇒ Array<String>

この属性はyardocに対して設定するテキストファイルのパスを設定します。

Returns:

  • (Array<String>) —

    target text files

Since:

  • 0.9.0



48
49
50
 
# File 'lib/packnga/reference-task.rb', line 48

def text_files
  @text_files
end

#translate_languages ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    target languages

See Also:

Since:

  • 0.9.6



70
71
72
 
# File 'lib/packnga/reference-task.rb', line 70

def translate_languages
  @translate_languages
end