種類
- インスタンスメソッド (13)
- クラス (6)
- 定数 (3)
- 特異メソッド (3)
クラス
-
RDoc
:: CodeObject (1) -
RDoc
:: Context (7) -
RDoc
:: Generator :: JsonIndex (1) -
RDoc
:: Markup (1) -
RDoc
:: Parser (1) -
RDoc
:: Stats (2) -
RDoc
:: TopLevel (4)
モジュール
- RDoc (2)
キーワード
- AnonClass (1)
-
CLASS
_ MODIFIERS (1) - ClassModule (1)
-
KNOWN
_ CLASSES (1) - Markup (1)
- NormalClass (1)
- Options (1)
- SingleClass (1)
- TYPES (1)
-
add
_ class (1) -
add
_ class _ or _ module (2) -
add
_ module (1) -
add
_ special (1) -
all
_ classes _ and _ modules (1) - classes (1)
-
each
_ classmodule (1) -
find
_ class _ named (1) -
find
_ local _ symbol (1) -
initialize
_ classes _ and _ modules (1) - new (1)
-
num
_ classes (1) -
num
_ classes= (1) -
parse
_ files _ matching (1) -
remove
_ classes _ and _ modules (1)
検索結果
先頭5件
- RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass - RDoc
:: Context # add _ class _ or _ module(collection , class _ type , name , superclass = nil) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule - RDoc
:: TopLevel # add _ class _ or _ module(collection , class _ type , name , superclass) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule - RDoc
:: TopLevel . find _ class _ named(name) -> RDoc :: NormalClass | RDoc :: SingleClass | nil - RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass]
-
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (19528.0) -
引数で指定したクラスを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass... -
RDoc
:: Context # add _ class _ or _ module(collection , class _ type , name , superclass = nil) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (19528.0) -
collection に name で指定したクラス、モジュールを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass......オ
ブジェクトで指定します。
既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。... -
RDoc
:: TopLevel # add _ class _ or _ module(collection , class _ type , name , superclass) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (19528.0) -
collection に name で指定したクラス、モジュールを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass......オ
ブジェクトで指定します。
既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。... -
RDoc
:: TopLevel . find _ class _ named(name) -> RDoc :: NormalClass | RDoc :: SingleClass | nil (18907.0) -
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。
...
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。
@param name クラス名を文字列で指定します。... -
RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass] (18904.0) -
追加されたクラスの配列を返します。
追加されたクラスの配列を返します。 -
RDoc
:: Context # each _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (18904.0) -
追加されたクラス、モジュールに対してブロックを評価します。
...追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules... -
RDoc
:: TopLevel . all _ classes _ and _ modules -> [RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule] (18904.0) -
RDoc が収集したクラス、モジュールを配列で返します。
...
RDoc が収集したクラス、モジュールを配列で返します。... -
RDoc
:: CLASS _ MODIFIERS -> [String] (18310.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: CodeObject # remove _ classes _ and _ modules -> () (18304.0) -
何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。
...何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。... -
RDoc
:: Context # initialize _ classes _ and _ modules -> () (18304.0) -
追加されたクラスやモジュールをクリアします。
追加されたクラスやモジュールをクリアします。 -
RDoc
:: KNOWN _ CLASSES -> {String => String} (18304.0) -
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
...Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"
ライブラリの内部で使用します。... -
RDoc
:: Stats # num _ classes -> Integer (18304.0) -
解析したクラスの数を返します。
解析したクラスの数を返します。 -
RDoc
:: Stats # num _ classes=(val) (18304.0) -
解析したクラスの数を指定します。
解析したクラスの数を指定します。
@param val 数値を指定します。 -
RDoc
:: AnonClass (18004.0) -
匿名クラスを表現するクラスです。
匿名クラスを表現するクラスです。
現在は使用されていません。 -
RDoc
:: ClassModule (18004.0) -
クラスやモジュールを表現するための基本クラスです。
クラスやモジュールを表現するための基本クラスです。
ライブラリの内部で使用します。 -
RDoc
:: NormalClass (18004.0) -
クラスを表現するためのクラスです。
クラスを表現するためのクラスです。
特異クラスや匿名クラスは含まれません。
ライブラリの内部で使用します。 -
RDoc
:: SingleClass (18004.0) -
特異クラスを表現するクラスです。
特異クラスを表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (943.0) -
引数で指定したモジュールを追加します。
...ram class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class... -
RDoc
:: TopLevel # find _ local _ symbol(name) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule | RDoc :: AnyMethod | RDoc :: Alias | RDoc :: Attr | RDoc :: Constant (604.0) -
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。 -
RDoc
:: Context :: TYPES -> ["class" , "instance"] (307.0) -
メソッドの種類を文字列の配列で返します。
メソッドの種類を文字列の配列で返します。 -
RDoc
:: Generator :: JsonIndex . new(parent _ generator , options) -> RDoc :: Generator :: JsonIndex (22.0) -
RDoc::Generator::JsonIndex オブジェクトを初期化します。
...
RDoc::Generator::JsonIndex オブジェクトを初期化します。
@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します......。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。
@param options RDoc::Options オブジェクトを指定します。
parent_generator に渡されたものと同... -
RDoc
:: Markup (22.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
:: Markup # add _ special(pattern , name) -> () (22.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
:: Options (22.0) -
rdoc コマンドのオプションを解析するためのクラスです。
...rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックし......まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する......ます。
例:
class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self
def self.setup_options rdoc_options
op = rdoc_options.option_parser
op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dicti... -
RDoc
:: Parser # parse _ files _ matching(regexp) -> () (22.0) -
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
...マッチするファイルを解析できるパーサとして、
自身を登録します。
@param regexp 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end...