Class: Packnga::YARDTask

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

Overview

このクラスはYARD関連のタスクを定義します。このタスクはYARDを用いてドキュメントを生成します。

Since:

  • 0.9.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#base_dirString

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

Returns:

  • (String)

    path of base directory of document

Since:

  • 0.9.0



35
36
37
# File 'lib/packnga/yard-task.rb', line 35

def base_dir
  @base_dir
end

#optionsArray<String>

Returns custom yardoc command line options

Returns:

  • (Array<String>)

    custom yardoc command line options

Since:

  • 0.9.0



46
47
48
# File 'lib/packnga/yard-task.rb', line 46

def options
  @options
end

#readmeString

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

Returns:

  • (String)

    path of readme file

Since:

  • 0.9.0



31
32
33
# File 'lib/packnga/yard-task.rb', line 31

def readme
  @readme
end

#source_filesArray<String>

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

Returns:

  • (Array<String>)

    target source files

Since:

  • 0.9.0



39
40
41
# File 'lib/packnga/yard-task.rb', line 39

def source_files
  @source_files
end

#text_files=(value) ⇒ Array<String>

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

Returns:

  • (Array<String>)

    target text files

Since:

  • 0.9.0



43
44
45
# File 'lib/packnga/yard-task.rb', line 43

def text_files=(value)
  @text_files = value
end

Instance Method Details

#before_define(&hook) ⇒ Object

与えられたブロックをyardocにパラメータを設定するものとして登録します。

Since:

  • 0.9.0



71
72
73
# File 'lib/packnga/yard-task.rb', line 71

def before_define(&hook)
  @hooks << hook
end