検索結果

RDoc::Markdown#html -> bool (63355.0)

• 3.1

• インスタンスメソッド

HTML を記述した場合にそのまま出力するかどうかを返します。

HTML を記述した場合にそのまま出力するかどうかを返します。

デフォルトでは true を返します。

• RDoc::Markdown

Rake::RDocTask#rdoc_dir -> String (27403.0)

• 3.1

• インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。

作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。

• Rake::RDocTask

RDoc::Markup#add_html(tag, name) -> () (27379.0)

• 3.1

• インスタンスメソッド

tag で指定したタグをフォーマットの対象にします。

tag で指定したタグをフォーマットの対象にします。

@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_ht...

• RDoc::Markup
• SM::ToHtml

RDoc::Markdown#html=(val) (27355.0)

• 3.1

• インスタンスメソッド

HTML を記述した場合にそのまま出力するかどうかを設定します。

HTML を記述した場合にそのまま出力するかどうかを設定します。

• RDoc::Markdown

Rake::RDocTask#rdoc_dir=(dir) (27355.0)

• 3.1

• インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名をセットします。

作成した HTML ファイルを保存するディレクトリ名をセットします。

• Rake::RDocTask

絞り込み条件を変える

RDoc::Markup#add_special(pattern, name) -> () (9076.0)

• 3.1

• インスタンスメソッド

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま す。

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま
す。

例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。

@param pattern 正規表現を指定します。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require '...

• RDoc::Markup
• SM::ToHtml

RDoc::Markup::Formatter#add_tag(name, start, stop) -> () (9076.0)

• 3.1

• インスタンスメソッド

name で登録された規則で取得された文字列を start と stop で囲むように指 定します。

name で登録された規則で取得された文字列を start と stop で囲むように指
定します。

@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。

@param start 開始の記号を文字列で指定します。

@param stop 終了の記号を文字列で指定します。

例:

require 'rdoc/markup/to_html'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup:...

• RDoc::Markup::Formatter
• RDoc::Markup::ToHtml

RDoc::Markup#add_word_pair(start, stop, name) -> () (9058.0)

• 3.1

• インスタンスメソッド

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。

@param start 開始となる文字列を指定します。

@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。

例:

require 'rdoc/markup/...

• RDoc::Markup
• SM::ToHtml

RDoc::Generator::Darkfish#generate -> () (9052.0)

• 3.1

• インスタンスメソッド

解析した情報を HTML ファイルや検索用のインデックスに出力します。

解析した情報を HTML ファイルや検索用のインデックスに出力します。

• RDoc::Generator::Darkfish

RDoc::Options#generator -> Generator (9022.0)

• 3.1

• インスタンスメソッド

コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。

コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。

指定しなかった場合は、HTML に対応する Generator を返します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#template -> String (9022.0)

• 3.1

• インスタンスメソッド

コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。

コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。

指定しなかった場合は 'html' を返します。

• RDoc::Options

Module#refine(klass) { ... } -> Module (58.0)

• 3.1

• インスタンスメソッド

引数 klass で指定したクラスまたはモジュールだけに対して、ブロックで指定した機能を提供で きるモジュールを定義します。定義した機能は Module#refine を使用せずに直 接 klass に対して変更を行う場合と異なり、限られた範囲のみ有効にできます。 そのため、既存の機能を局所的に修正したい場合などに用いる事ができます。

引数 klass で指定したクラスまたはモジュールだけに対して、ブロックで指定した機能を提供で
きるモジュールを定義します。定義した機能は Module#refine を使用せずに直
接 klass に対して変更を行う場合と異なり、限られた範囲のみ有効にできます。
そのため、既存の機能を局所的に修正したい場合などに用いる事ができます。

refinements 機能の詳細については以下を参照してください。

* https://magazine.rubyist.net/articles/0041/0041-200Special-refinement.html
* https://docs...

• Module

Module#using(module) -> self (40.0)

• 3.1

• インスタンスメソッド

引数で指定したモジュールで定義された拡張を現在のクラス、モジュールで有 効にします。

引数で指定したモジュールで定義された拡張を現在のクラス、モジュールで有
効にします。

有効にした拡張の有効範囲については以下を参照してください。

* https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html#label-Scope

@param module 有効にするモジュールを指定します。

@see Module#refine, main.using

• Module