Class: Packnga::YARDTask
- Inherits:
-
Object
- Object
- Packnga::YARDTask
- Includes:
- Rake::DSL
- Defined in:
- lib/packnga/yard-task.rb
Overview
このクラスはYARD関連のタスクを定義します。このタスクはYARDを用いてドキュメントを生成します。
Instance Attribute Summary collapse
-
#base_dir ⇒ String
この属性はドキュメントのベースディレクトリを表します。.
-
#options ⇒ Array<String>
Custom yardoc command line options.
-
#readme ⇒ String
この属性はyardocに対して設定するReadmeファイルのパスを設定します.
-
#source_files ⇒ Array<String>
この属性はyardocに対して設定するソースファイルのパスを設定します。.
-
#text_files ⇒ Array<String>
writeonly
この属性はyardocに対して設定するテキストファイルのパスを設定します。.
Instance Method Summary collapse
-
#before_define(&hook) ⇒ Object
与えられたブロックをyardocにパラメータを設定するものとして登録します。.
Instance Attribute Details
#base_dir ⇒ String
この属性はドキュメントのベースディレクトリを表します。
35 36 37 |
# File 'lib/packnga/yard-task.rb', line 35 def base_dir @base_dir end |
#options ⇒ Array<String>
Returns custom yardoc command line options
46 47 48 |
# File 'lib/packnga/yard-task.rb', line 46 def @options end |
#readme ⇒ String
この属性はyardocに対して設定するReadmeファイルのパスを設定します
31 32 33 |
# File 'lib/packnga/yard-task.rb', line 31 def readme @readme end |
#source_files ⇒ Array<String>
この属性はyardocに対して設定するソースファイルのパスを設定します。
39 40 41 |
# File 'lib/packnga/yard-task.rb', line 39 def source_files @source_files end |
#text_files=(value) ⇒ Array<String>
この属性はyardocに対して設定するテキストファイルのパスを設定します。
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にパラメータを設定するものとして登録します。
71 72 73 |
# File 'lib/packnga/yard-task.rb', line 71 def before_define(&hook) @hooks << hook end |