バージョン:2.5.0 > クエリ:- > クエリ:h > ライブラリ:rdoc

48件ヒット [1-48件を表示] （0.058秒）

トップページ >

:2.5.0

:rdoc

別のキーワード

種類

クラス

モジュール

RDoc (1)
RDoc::Text (2)

キーワード

検索結果

RDoc::Context#add_method(a_method) -> () (18904.0)

2.5.0

インスタンスメソッド

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

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

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

RDoc::Context#method_list -> [RDoc::AnyMethod] (18904.0)

2.5.0

インスタンスメソッド

追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列を返します。

...追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。...

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

2.5.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::Options#hyperlink_all -> bool (18652.0)

2.5.0

インスタンスメソッド

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

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

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

RDoc::Options#show_hash -> bool (18652.0)

2.5.0

インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Options#static_path -> [String] (18652.0)

2.5.0

インスタンスメソッド

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返します。

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。

RDoc::Options#tab_width -> Integer (18652.0)

2.5.0

インスタンスメソッド

コマンドライン引数の --tab-width オプションで指定した数値を返します。

RDoc::METHOD_MODIFIERS -> [String] (18607.0)

2.5.0

定数

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

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

2.5.0

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self...

RDoc::CodeObject#remove_methods_etc -> () (18604.0)

2.5.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.5.0

インスタンスメソッド

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

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

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

2.5.0

インスタンスメソッド

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

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

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

RDoc::Context#each_constant {|c| ... } -> [RDoc::Constant] (18604.0)

2.5.0

インスタンスメソッド

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

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

RDoc::Context#each_method {|m| ... } -> [RDoc::AnyMethod] (18604.0)

2.5.0

インスタンスメソッド

追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。

...追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。...

RDoc::Context#initialize_methods_etc -> () (18604.0)

2.5.0

インスタンスメソッド

追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れていないものを含む)、require されたファイル、include されたファイル、定数をクリアします。

追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。

絞り込み条件を変える

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

2.5.0

インスタンスメソッド

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

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

RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE -> String (18604.0)

2.5.0

定数

検索インデックスのパスを表す文字列です。

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

2.5.0

インスタンスメソッド

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

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

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

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

2.5.0

インスタンスメソッド

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

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

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

RDoc::Markdown::HTML_ENTITIES -> {String => [Integer]} (18604.0)

2.5.0

定数

HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。

...HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。...

絞り込み条件を変える

RDoc::Options#charset -> String (18604.0)

2.5.0

インスタンスメソッド

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

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

指定しなかった場合は、$KCODE に応じた値になります。

RDoc::Options#show_all -> bool (18604.0)

2.5.0

インスタンスメソッド

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

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

RDoc::Parser#parse_files_matching(regexp) -> () (18604.0)

2.5.0

インスタンスメソッド

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、自身を登録します。

...マッチするファイルを解析できるパーサとして、
自身を登録します。

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

新しいパーサを作成する時に使用します。

例:

class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end...

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

2.5.0

インスタンスメソッド

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

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

2.5.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Text#strip_hashes(text) -> String (18604.0)

2.5.0

インスタンスメソッド

引数から各行の行頭の # を削除します。

引数から各行の行頭の # を削除します。

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

RDoc::Options#hyperlink_all=(val) (18370.0)

2.5.0

インスタンスメソッド

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

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

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

RDoc::Options#static_path=(vals) (18352.0)

2.5.0

インスタンスメソッド

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

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

@param vals パスを文字列の配列で指定します。

RDoc::Generator::Darkfish#initialize(store, options) -> RDoc::Generator::Darkfish (9604.0)

2.5.0

インスタンスメソッド

RDoc::Generator::Darkfish オブジェクトを初期化します。

...
RDoc::Generator::Darkfish オブジェクトを初期化します。

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

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

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

2.5.0

特異メソッド

自身を初期化します。

絞り込み条件を変える

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

2.5.0

特異メソッド

自身を初期化します。

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

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

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

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

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

2.5.0

インスタンスメソッド

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

RDoc::Generator::Darkfish::GENERATOR_DIR -> String (9304.0)

2.5.0

定数

このファイルの親ディレクトリへのパスを表す文字列です。

このファイルの親ディレクトリへのパスを表す文字列です。

テンプレートなどのリソースを検索するのに内部で使用します。

RDoc::Generator::Darkfish::VERSION -> '3' (9304.0)

2.5.0

定数

darkfish のバージョンです。

RDoc::Parser::ChangeLog#scan -> RDoc::TopLevel (9304.0)

2.5.0

インスタンスメソッド

ChangeLog ファイルを解析します。

...ChangeLog ファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。...

絞り込み条件を変える

RDoc::Options#page_dir -> Pathname | nil (652.0)

2.5.0

インスタンスメソッド

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

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

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

RDoc::Context#<=>(other) -> -1 | 0 | 1 (607.0)

2.5.0

インスタンスメソッド

自身と other の full_name を比較した結果を返します。

自身と other の full_name を比較した結果を返します。

ソートのために使われます。

@param other 自身と比較したいオブジェクトを指定します。

RDoc::CodeObject#metadata -> Hash (604.0)

2.5.0

インスタンスメソッド

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

RDoc::Context#add_to(array, thing) -> () (604.0)

2.5.0

インスタンスメソッド

array に thing を追加します。

...を指定します。

RDoc::Context#add_alias などで使われています。ライブラリ内部で使
用します。

@see RDoc::Context#add_alias, RDoc::Context#add_attribute,
RDoc::Context#add_constant, RDoc::Context#add_include,
RDoc::Context#add_method, RDoc::Context#add_require...

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (604.0)

2.5.0

インスタンスメソッド

methods で指定した RDoc::AnyMethod、RDoc::Attr の内、 singleton で指定した条件と一致するメソッドすべての可視性を visibility に設定します。

...methods で指定した RDoc::AnyMethod、RDoc::Attr の内、
singleton で指定した条件と一致するメソッドすべての可視性を visibility
に設定します。

@param methods RDoc::AnyMethod、RDoc::Attr オブジェクトの配
列を指定します。

@param vi...

絞り込み条件を変える

RDoc::Context::Section#==(other) -> bool (604.0)

2.5.0

インスタンスメソッド

自身と other のシーケンス番号を比較した結果を返します。

...自身と other のシーケンス番号を比較した結果を返します。

@param other RDoc::Context::Section オブジェクトを指定します。...

RDoc::Options#root -> Pathname (604.0)

2.5.0

インスタンスメソッド

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

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

指定されていない場合はカレントディレクトリを返します。

2.5.0

インスタンスメソッド

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

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

2.5.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) -> () (358.0)

2.5.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::Context#find_symbol(symbol, method=nil) (352.0)

2.5.0

インスタンスメソッド

Look up the given symbol. If method is non-nil, then we assume the symbol references a module that contains that method

Look up the given symbol. If method is non-nil, then we assume
the symbol references a module that contains that method

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

2.5.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 (94.0)

2.5.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)
を変更、拡張する必要があります。...

別のキーワード

種類

クラス

モジュール

キーワード

検索結果

先頭5件

RDoc::Context#add_method(a_method) -> () (18904.0)

RDoc::Context#method_list -> [RDoc::AnyMethod] (18904.0)

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

RDoc::Options#hyperlink_all -> bool (18652.0)

RDoc::Options#show_hash -> bool (18652.0)

RDoc::Options#static_path -> [String] (18652.0)

RDoc::Options#tab_width -> Integer (18652.0)

RDoc::METHOD_MODIFIERS -> [String] (18607.0)

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

RDoc::CodeObject#remove_methods_etc -> () (18604.0)

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

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

RDoc::Context#each_constant {|c| ... } -> [RDoc::Constant] (18604.0)

RDoc::Context#each_method {|m| ... } -> [RDoc::AnyMethod] (18604.0)

RDoc::Context#initialize_methods_etc -> () (18604.0)

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

RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE -> String (18604.0)

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

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

RDoc::Markdown::HTML_ENTITIES -> {String => [Integer]} (18604.0)

RDoc::Options#charset -> String (18604.0)

RDoc::Options#show_all -> bool (18604.0)

RDoc::Parser#parse_files_matching(regexp) -> () (18604.0)

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

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

RDoc::Text#strip_hashes(text) -> String (18604.0)

RDoc::Options#hyperlink_all=(val) (18370.0)

RDoc::Options#static_path=(vals) (18352.0)

RDoc::Generator::Darkfish#initialize(store, options) -> RDoc::Generator::Darkfish (9604.0)

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

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

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

RDoc::Generator::Darkfish::GENERATOR_DIR -> String (9304.0)

RDoc::Generator::Darkfish::VERSION -> &#39;3&#39; (9304.0)

RDoc::Parser::ChangeLog#scan -> RDoc::TopLevel (9304.0)

RDoc::Options#page_dir -> Pathname | nil (652.0)

RDoc::Context#<=>(other) -> -1 | 0 | 1 (607.0)

RDoc::CodeObject#metadata -> Hash (604.0)

RDoc::Context#add_to(array, thing) -> () (604.0)

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (604.0)

RDoc::Context::Section#==(other) -> bool (604.0)

RDoc::Options#root -> Pathname (604.0)

RDoc::TopLevel#find_local_symbol(name) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule | RDoc::AnyMethod | RDoc::Alias | RDoc::Attr | RDoc::Constant (604.0)

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

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

RDoc::Context#find_symbol(symbol, method=nil) (352.0)

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

RDoc::Markup (94.0)

RDoc::Generator::Darkfish::VERSION -> '3' (9304.0)