クエリ:u > バージョン:2.3.0 > ライブラリ:rdoc

111件ヒット [1-100件を表示] （0.056秒）

トップページ >

:2.3.0

:rdoc

別のキーワード

種類

クラス

モジュール

RDoc (1)
RDoc::Text (3)

キーワード

検索結果

<< 1 2 > >>

RDoc::Options#force_output -> bool (36604.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返します。

コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。

どちらも指定しなかった場合は true を返します。

RDoc::Options#force_output=(val) (36604.0)

2.3.0

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --force_output オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。

@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。

RDoc::Context#add_attribute(an_attribute) -> () (18604.0)

2.3.0

インスタンスメソッド

引数で指定した RDoc::Attr オブジェクトを追加します。

...引数で指定した RDoc::Attr オブジェクトを追加します。

@param an_attribute RDoc::Attr オブジェクトを指定します。...

RDoc::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (18604.0)

2.3.0

インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param superclass 追加するクラスの親クラスを RDoc::NormalClass...

...オ
ブジェクトで指定します。

既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。...

RDoc::Context#add_include(an_include) -> () (18604.0)

2.3.0

インスタンスメソッド

引数で指定した RDoc::Include オブジェクトを追加します。

...引数で指定した RDoc::Include オブジェクトを追加します。

@param an_include RDoc::Include オブジェクトを指定します。...

絞り込み条件を変える

RDoc::Context#add_module(class_type, name) -> RDoc::NormalModule | RDoc::SingleClass | RDoc::NormalClass (18604.0)

2.3.0

インスタンスメソッド

引数で指定したモジュールを追加します。

...ram class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@see RDoc::Context#add_class...

RDoc::Context#add_require(a_require) -> () (18604.0)

2.3.0

インスタンスメソッド

自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。

...自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。

@param a_require RDoc::Require オブジェクトを指定します。...

RDoc::Context#each_classmodule {|m| ... } -> [RDoc::SingleClass | RDoc::NormalClass | RDoc::NormalModule] (18604.0)

2.3.0

インスタンスメソッド

追加されたクラス、モジュールに対してブロックを評価します。

...追加されたクラス、モジュールに対してブロックを評価します。

@see RDoc::Context#classes, RDoc::Context#modules...

RDoc::Context#find_enclosing_module_named(name) -> RDoc::NormalModule | nil (18604.0)

2.3.0

インスタンスメソッド

find a module at a higher scope

RDoc::Context#find_module_named(name) -> RDoc::NormalModule | nil (18604.0)

2.3.0

インスタンスメソッド

追加された RDoc::NormalModule から引数で指定した名前のモジュールを検索します。見つからなかった場合は nil を返します。

...追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。

@param name モジュールの名前を文字列で指定します。...

絞り込み条件を変える

RDoc::Context#includes -> [RDoc::Include] (18604.0)

2.3.0

インスタンスメソッド

追加された RDoc::Include の配列を返します。

...追加された RDoc::Include の配列を返します。...

RDoc::Context#modules -> [RDoc::NormalModule] (18604.0)

2.3.0

インスタンスメソッド

追加された RDoc::NormalModule の配列を返します。

...追加された RDoc::NormalModule の配列を返します。...

RDoc::Context#requires -> [RDoc::Require] (18604.0)

2.3.0

インスタンスメソッド

追加された RDoc::Require の配列を返します。

...追加された RDoc::Require の配列を返します。...

RDoc::Markup#attribute_manager -> RDoc::AttributeManager (18604.0)

2.3.0

インスタンスメソッド

自身の RDoc::AttributeManager オブジェクトを返します。

...自身の RDoc::AttributeManager オブジェクトを返します。...

RDoc::TopLevel#add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (18604.0)

2.3.0

インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

絞り込み条件を変える

RDoc::TopLevel#find_module_named(name) -> RDoc::NormalModule (18604.0)

2.3.0

インスタンスメソッド

RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。見つからなかった場合は nil を返します。

...
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。

@param name モジュール名を文字列で指定します。...

RDoc::TopLevel.all_classes_and_modules -> [RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule] (18604.0)

2.3.0

特異メソッド

RDoc が収集したクラス、モジュールを配列で返します。

...
RDoc が収集したクラス、モジュールを配列で返します。...

RDoc::CodeObject#document_children -> bool (18304.0)

2.3.0

インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを返します。

...自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。

@see RDoc::CodeObject#document_self...

RDoc::CodeObject#document_children=(val) (18304.0)

2.3.0

インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを設定します。

...トに含めるか
どうかを設定します。

:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、上記をドキュメントに含めます。

@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules...

RDoc::CodeObject#document_self -> bool (18304.0)

2.3.0

インスタンスメソッド

自身をドキュメントに含めるかどうかを返します。

...自身をドキュメントに含めるかどうかを返します。

@see RDoc::CodeObject#document_children...

絞り込み条件を変える

RDoc::CodeObject#document_self=(val) (18304.0)

2.3.0

インスタンスメソッド

自身をドキュメントに含めるかどうかを設定します。

...c: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、自身をドキュメントに含めます。

@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc...

RDoc::CodeObject#documented? -> bool (18304.0)

2.3.0

インスタンスメソッド

出力すべきドキュメントがあるかどうかを返します。

RDoc::CodeObject#remove_classes_and_modules -> () (18304.0)

2.3.0

インスタンスメソッド

何もしません。RDoc::CodeObject#document_children= に false を指定した時のコールバックとして呼び出されます。オーバーライドして使用します。

...何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。...

RDoc::Context#attributes -> [RDoc::Attr] (18304.0)

2.3.0

インスタンスメソッド

追加された RDoc::Attr の配列を返します。

...追加された RDoc::Attr の配列を返します。...

RDoc::Context#current_section -> RDoc::Context::Section (18304.0)

2.3.0

インスタンスメソッド

現在の section を返します。

絞り込み条件を変える

RDoc::Context#each_attribute {|a| ... } -> [RDoc::Attr] (18304.0)

2.3.0

インスタンスメソッド

追加された RDoc::Attr に対してブロックを評価します。

...追加された RDoc::Attr に対してブロックを評価します。...

RDoc::Context#initialize_classes_and_modules -> () (18304.0)

2.3.0

インスタンスメソッド

追加されたクラスやモジュールをクリアします。

RDoc::Context#set_current_section(title, comment) -> () (18304.0)

2.3.0

インスタンスメソッド

Handle sections

RDoc::Context#unmatched_alias_lists -> {String => RDoc::Alias} (18304.0)

2.3.0

インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。

...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。...

RDoc::Context#unmatched_alias_lists=(val) (18304.0)

2.3.0

インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。

...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。

@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。...

絞り込み条件を変える

RDoc::Context::Section#sequence -> String (18304.0)

2.3.0

インスタンスメソッド

section のシーケンス番号を文字列で返します。

section のシーケンス番号を文字列で返します。

リンクを作成する時に使われます。

RDoc::Markdown#github -> bool (18304.0)

2.3.0

インスタンスメソッド

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返します。

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し
ます。

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

RDoc::Markdown#github=(val) (18304.0)

2.3.0

インスタンスメソッド

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定します。

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定
します。

RDoc::Markdown::DEFAULT_EXTENSIONS -> [Symbol] (18304.0)

2.3.0

定数

デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。

RDoc::Options#dry_run -> bool (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --dry-run オプションを指定していた場合、true を返します。--no-dry-run オプションを指定していた場合、false を返します。

コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。

どちらも指定しなかった場合は false を返します。

絞り込み条件を変える

RDoc::Options#dry_run=(val) (18304.0)

2.3.0

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --dry-run オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --dry-run オプションと
同様の指定を行います。

@param val --dry-run オプションと同じ指定を行う場合は true、そうでない
場合は false を指定します。

RDoc::Options#exclude -> Regexp (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --exclude オプションで指定した正規表現を返します。複数指定していた場合は、1 つの Regexp オブジェクトにまとめられたものを返します。

コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。

RDoc::Options#exclude=(val) (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --exclude オプションと同様の指定を行います。

コマンドライン引数の --exclude オプションと同様の指定を行います。

@param val 設定するパターンを Regexp オブジェクトで指定します。

RDoc::Options#force_update -> bool (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --force_update を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。

RDoc::Options#include_line_numbers -> bool (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。

絞り込み条件を変える

RDoc::Options#inline_source -> bool (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --inline-source オプションか --one-file を指定していた場合、もしくは --fmt オプションに xml 指定した場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。

RDoc::Options#line_numbers -> bool (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返します。

コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。

どちらも指定しなかった場合は false を返します。

RDoc::Options#line_numbers=(val) (18304.0)

2.3.0

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --line-numbers オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。

@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。

RDoc::Options#markup -> String (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --markup オプションで指定したフォーマットを返します。

...コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。

指定されていない場合は 'rdoc' を返します。...

RDoc::Options#markup=(val) (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --markup オプションと同様の指定を行います。

コマンドライン引数の --markup オプションと同様の指定を行います。

@param val フォーマットを文字列で指定します。

絞り込み条件を変える

RDoc::Options#promiscuous (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --promiscuous を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --promiscuous を指定していた場合に true を返します。
そうでない場合は false を返します。

RDoc::Options#quiet -> bool (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --quiet オプションを指定していた場合、true を返します。そうでない場合は nil を返します。

コマンドライン引数の --quiet オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。

RDoc::Options#rdoc_include -> [String] (18304.0)

2.3.0

インスタンスメソッド

コマンドライン引数の --include オプションで指定したディレクトリを文字列の配列で返します。

コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。

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

RDoc::RDoc#document(argv) -> nil (18304.0)

2.3.0

インスタンスメソッド

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディレクトリに出力します。

...ドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。

@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、lib:rdoc#usage を参照し...

RDoc::Stats#num_classes -> Integer (18304.0)

2.3.0

インスタンスメソッド

解析したクラスの数を返します。

絞り込み条件を変える

RDoc::Stats#num_classes=(val) (18304.0)

2.3.0

インスタンスメソッド

解析したクラスの数を指定します。

解析したクラスの数を指定します。

@param val 数値を指定します。

RDoc::Stats#num_files -> Integer (18304.0)

2.3.0

インスタンスメソッド

解析したファイルの数を返します。

RDoc::Stats#num_files=(val) (18304.0)

2.3.0

インスタンスメソッド

解析したファイルの数を指定します。

解析したファイルの数を指定します。

@param val 数値を指定します。

RDoc::Stats#num_methods -> Integer (18304.0)

2.3.0

インスタンスメソッド

解析したメソッドの数を返します。

RDoc::Stats#num_methods=(val) (18304.0)

2.3.0

インスタンスメソッド

解析したメソッドの数を指定します。

解析したメソッドの数を指定します。

@param val 数値を指定します。

絞り込み条件を変える

RDoc::Stats#num_modules -> Integer (18304.0)

2.3.0

インスタンスメソッド

解析したモジュールの数を返します。

RDoc::Stats#num_modules=(val) (18304.0)

2.3.0

インスタンスメソッド

解析したモジュールの数を指定します。

解析したモジュールの数を指定します。

@param val 数値を指定します。

RDoc::Text#flush_left(text) -> String (18304.0)

2.3.0

インスタンスメソッド

引数から各行の行頭のスペースを削除します。

引数から各行の行頭のスペースを削除します。

@param text 文字列を指定します。

RDoc::Text#markup(text) -> String (18304.0)

2.3.0

インスタンスメソッド

引数を整形します。

引数を整形します。

include したクラスに self#formatter メソッドが必要です。

@param text 文字列を指定します。

RDoc::TopLevel#file_absolute_name -> String (18304.0)

2.3.0

インスタンスメソッド

自身が管理するファイルに関する絶対パスを文字列で返します。

絞り込み条件を変える

RDoc::TopLevel#file_absolute_name=(val) (18304.0)

2.3.0

インスタンスメソッド

自身が管理するファイルに関する絶対パスを文字列で設定します。

自身が管理するファイルに関する絶対パスを文字列で設定します。

@param val パスを文字列で指定します。

RDoc::TopLevel#full_name -> String (18304.0)

2.3.0

インスタンスメソッド

自身が管理するファイルの名前を返します。

RDoc::ClassModule (18004.0)

2.3.0

クラス

クラスやモジュールを表現するための基本クラスです。

クラスやモジュールを表現するための基本クラスです。

ライブラリの内部で使用します。

RDoc::Generator::Markup (18004.0)

2.3.0

モジュール

ライブラリ内部で使用します。

RDoc::Include (18004.0)

2.3.0

クラス

includeされるファイルを表現します。

includeされるファイルを表現します。

ライブラリの内部で使用します。

絞り込み条件を変える

RDoc::Markup (18004.0)

2.3.0

クラス

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

...RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

例:

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

独自のフォーマットを行うようにパーサを拡張する事もできます。

例:

req...

...uire 'rdoc/markup'
require 'rdoc/markup/to_html'

class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
def handle_special_WIKIWORD(special)
"<font color=red>" + special.text + "</font>"
end
end

m = RDoc::Markup.new
# { 〜 } までを :STRIK...

...STRIKE のフォーマットを <strike> 〜 </strike> に指定。
wh.add_tag(:STRIKE, "<strike>", "</strike>")

puts "<body>#{wh.convert ARGF.read}</body>"

変換する形式を変更する場合、フォーマッタ(例. RDoc::Markup::ToHtml)
を変更、拡張する必要があります。...

RDoc::NormalModule (18004.0)

2.3.0

クラス

モジュールを表現するクラスです。

モジュールを表現するクラスです。

ライブラリの内部で使用します。

RDoc::Parser::Ruby (18004.0)

2.3.0

クラス

Ruby のソースコードを解析するためのクラスです。

RDoc::Parser::RubyTools (18004.0)

2.3.0

モジュール

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコードのパーサを記述するためのメソッドを定義するモジュールです。

...RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのメソッドを定義するモジュールです。

RDoc::Parser を継承していないため、パーサクラスとしては利用できま
せん。

ライブラリの内部で使用...

RDoc::Require (18004.0)

2.3.0

クラス

require されるファイルを表現します。

require されるファイルを表現します。

ライブラリの内部で使用します。

絞り込み条件を変える

RDoc::RubyLex (18004.0)

2.3.0

クラス

ライブラリの内部で使用します。

RDoc::RubyToken (18004.0)

2.3.0

モジュール

ライブラリの内部で使用します。

RDoc::Markup::Formatter.new(markup = nil) -> RDoc::Markup::Formatter (9604.0)

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。...

RDoc::Markup::ToAnsi.new(markup = nil) -> RDoc::Markup::ToAnsi (9604.0)

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。...

RDoc::Markup::ToBs.new(markup = nil) -> RDoc::Markup::ToBs (9604.0)

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。...

絞り込み条件を変える

RDoc::Markup::ToRdoc.new(markup = nil) -> RDoc::Markup::ToRdoc (9604.0)

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。...

RDoc::Markup.new(attribute_manager = nil) -> RDoc::Markup (9304.0)

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。...

RDoc::Markup::ToHtml.new -> RDoc::Markup::ToHtml (9304.0)

2.3.0

特異メソッド

自身を初期化します。

RDoc::Markup::ToHtmlCrossref.new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref (9304.0)

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

@param path 生成するファイルのパスを文字列で指定します。

@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。

@param show_hash true を指定した場合、メソッ...

RDoc::Parser::Ruby.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Ruby (9304.0)

2.3.0

特異メソッド

自身を初期化します。

...op_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats...

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_html("no", :STRIKE)

h = SM::ToHtml.new
h.add_tag(:STRIKE,...

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

2.3.0

インスタンスメソッド

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

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'

class WikiHtml < SM::ToHtml
def handle_special_WIKIWORD(special)
"<font color=red>" +...

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

2.3.0

インスタンスメソッド

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

...ます。

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_word_pair("{", "}", :STRIKE)

h = SM::ToHtml.new
h.add_tag(:S...

RDoc::Markup#content -> String (9004.0)

2.3.0

インスタンスメソッド

変換する文字列を返します。

...変換する文字列を返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる...

RDoc::Markup#convert(str, formatter) -> object | "" (9004.0)

2.3.0

インスタンスメソッド

str で指定された文字列を formatter に変換させます。

str で指定された文字列を formatter に変換させます。

@param str 変換する文字列を指定します。

@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。

変換結果は formatter によって文字列や配列を返します。

絞り込み条件を変える

RDoc::Markup#get_line_types -> [Symbol] (9004.0)

2.3.0

インスタンスメソッド

変換する文字列の各行のタイプを Symbol の配列で返します。

...変換する文字列の各行のタイプを Symbol の配列で返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

@see SM::SimpleMarkup#convert...

RDoc::Markup::Formatter (9004.0)

2.3.0

クラス

RDoc 形式のドキュメントを整形するための基本クラスです。

...RDoc 形式のドキュメントを整形するための基本クラスです。

実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、
継承したクラスで convert メソッドを実行してください。...

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

2.3.0

インスタンスメソッド

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

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

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

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

例:

require 'rdoc/markup/to_html...

...'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup::ToHtml.new
h.add_tag(:STRIKE, "<strike>", "</strike>")...

RDoc::Markup::Formatter#convert(content) -> () (9004.0)