クエリ:a > ライブラリ:rdoc > バージョン:3.0

237件ヒット [1-100件を表示] （0.142秒）

トップページ >

:rdoc

:3.0

別のキーワード

種類

クラス

モジュール

RDoc (6)
RDoc::Text (6)

キーワード

検索結果

<< 1 2 3 > >>

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (27904.0)

インスタンスメソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

...引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。...

RDoc::Markdown.parse(markdown) -> RDoc::Markup::Document (27904.0)

特異メソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (27604.0)

特異メソッド

file_name を解析できるパーサのインスタンスを返します。見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。

... RDoc::Parser::Simple のインスタンスを返します。

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

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

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

@param options RDoc::Op...

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

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

絞り込み条件を変える

RDoc::Parser.parsers -> [[Regexp, RDoc::Parser]] (27604.0)

特異メソッド

RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラスの配列の配列を返します。

...
RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ
スの配列の配列を返します。...

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

インスタンスメソッド

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

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

定数

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

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

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

RDoc::Generator::JsonIndex#generate -> () (27304.0)

インスタンスメソッド

解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出力します。

...解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。...

RDoc::Generator::RI#generate -> () (27304.0)

インスタンスメソッド

解析した情報を ri コマンドから読めるようにファイルに出力します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

例:

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

RDoc::Parser.can_parse(file_name) -> RDoc::Parser | nil (27304.0)

特異メソッド

file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。

file_name を解析できるパーサクラスを返します。見つからなかった場合は
nil を返します。

@param file_name 解析するファイルの名前を指定します。

RDoc::Parser::Markdown#scan -> RDoc::TopLevel (27304.0)

インスタンスメソッド

Markdown 形式で記述されたファイルを解析します。

...Markdown 形式で記述されたファイルを解析します。

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

RDoc::Parser::Markdown (27004.0)

クラス

Markdown 形式で記述されたファイルを解析するためのクラスです。

Markdown 形式で記述されたファイルを解析するためのクラスです。

解析された情報はコメントとして扱われます。

インスタンスメソッド

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

絞り込み条件を変える

RDoc::Context#classes -> [RDoc::SingleClass | RDoc::NormalClass] (18904.0)

インスタンスメソッド

追加されたクラスの配列を返します。

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (18904.0)

インスタンスメソッド

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削除した後に解析を行います。

...引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。

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

@see RDoc::Text#normalize_comment...

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

特異メソッド

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

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

RDoc::TopLevel.find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil (18904.0)

特異メソッド

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

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

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

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

インスタンスメソッド

find a module at a higher scope

絞り込み条件を変える

RDoc::Context#aliases -> [RDoc::Alias] (18604.0)

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

RDoc::Context#constants -> [RDoc::Constant] (18604.0)

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

RDoc::Options#option_parser -> OptionParser | nil (18604.0)

インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを返します。

コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。

RDoc::Options#parse(argv) -> () (18604.0)

インスタンスメソッド

コマンドライン引数を解析します。

コマンドライン引数を解析します。

@param argv コマンドライン引数を文字列の配列で指定します。

また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。

* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合

RDoc::Options#show_all=(val) (18604.0)

インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::TopLevel#file_stat -> File::Stat (18604.0)

インスタンスメソッド

自身が管理するファイルに関する File::Stat オブジェクトを返します。

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

インスタンスメソッド

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

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

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

RDoc::Markup#add_special(pattern, name) -> () (18358.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::Context#find_local_symbol(symbol) (18352.0)

インスタンスメソッド

Finds a method, constant, attribute, module or files named +symbol+ in this context

Finds a method, constant, attribute, module or files named +symbol+ in
this context

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

RDoc::ATTR_MODIFIERS -> [String] (18307.0)

定数

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

RDoc::CLASS_MODIFIERS -> [String] (18307.0)

定数

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

RDoc::CONSTANT_MODIFIERS -> [String] (18307.0)

定数

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::DOT_DOC_FILENAME -> ".document" (18307.0)

定数

rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。

...
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。...

RDoc::GENERAL_MODIFIERS -> [String] (18307.0)

定数

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

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

インスタンスメソッド

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

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

インスタンスメソッド

自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。

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

インスタンスメソッド

自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。

...自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。

@param val RDoc::CodeObject のサブクラスのオブジェクトを指定しま
す。...

絞り込み条件を変える

RDoc::CodeObject#parent_file_name -> String (18304.0)

インスタンスメソッド

self.parent のファイル名を返します。

...self.parent のファイル名を返します。

@see RDoc::CodeObject#parent...

RDoc::CodeObject#parent_name -> String (18304.0)

インスタンスメソッド

self.parent の名前を返します。

...self.parent の名前を返します。

@see RDoc::CodeObject#parent...

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

インスタンスメソッド

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

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

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

インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまでの間、ドキュメントに含めます。

...たコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。

:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。

@see RDoc::CodeObject#end_d...

RDoc::Context#add_alias(an_alias) -> RDoc::Alias (18304.0)

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

RDoc::Context#add_class(class_type, name, superclass) -> RDoc::SingleClass | RDoc::NormalClass (18304.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 (18304.0)

インスタンスメソッド

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

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

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

RDoc::Context#add_constant(const) -> () (18304.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

@see RDoc::Context#add_class...

RDoc::Context#add_to(array, thing) -> () (18304.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#each_classmodule {|m| ... } -> [RDoc::SingleClass | RDoc::NormalClass | RDoc::NormalModule] (18304.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

RDoc::Context#name -> String (18304.0)

インスタンスメソッド

自身の名前を返します。

自身の名前を返します。

サブクラスによっては、メソッド名やクラス名を意味します。

RDoc::Context#record_location(toplevel) (18304.0)

インスタンスメソッド

Record the file that we happen to find it in

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

自身が所属する RDoc::Context オブジェクトを返します。

...自身が所属する RDoc::Context オブジェクトを返します。...

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

インスタンスメソッド

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

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

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

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

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

定数

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

RDoc::Generator::RI#initialize(store, options) -> RDoc::Generator::RI (18304.0)

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

RDoc::KNOWN_CLASSES -> {String => String} (18304.0)

定数

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

...Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"

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

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

インスタンスメソッド

改行を保持した状態で出力するかどうかを返します。

改行を保持した状態で出力するかどうかを返します。

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

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

インスタンスメソッド

改行を保持した状態で出力するかどうかを設定します。

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

定数

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

RDoc::Markup#add_html(tag, name) -> () (18304.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_word_pair(start, stop, name) -> () (18304.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::Formatter#add_tag(name, start, stop) -> () (18304.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::LABEL_LIST_RE -> Regexp (18304.0)

定数

ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。

RDoc::Markup::SPACE -> ?\s (18304.0)

定数

空白文字です。?\s を返します。ライブラリの内部で使用します。

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

RDoc::Options#coverage_report -> Integer | false (18304.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

@param val 数値オブジェクトか false を指定します。

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

インスタンスメソッド

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

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

RDoc::Options#extra_accessor_flags -> {String => String} (18304.0)

インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサがキー、アクセサの種類が値のハッシュを返します。

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。

値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。

絞り込み条件を変える

RDoc::Options#extra_accessors -> Regexp | nil (18304.0)

インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべてにマッチする正規表現オブジェクトを返します。

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。

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

RDoc::Options#finish_page_dir (18304.0)

インスタンスメソッド

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

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

インスタンスメソッド

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

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

RDoc::Options#formatter -> nil (18304.0)

インスタンスメソッド

使用されていません。常に nil を返します。

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

インスタンスメソッド

使用されていません。

絞り込み条件を変える

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

インスタンスメソッド

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

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

@param val 設定する Generator を指定します。

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

RDoc::Options#main_page -> String | nil (18304.0)

インスタンスメソッド

コマンドライン引数の --main オプションで指定したファイル名、クラス/モジュール名を返します。

コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。

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

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

インスタンスメソッド

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

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

@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを設定します。

コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。

@param val OptionParser オブジェクトを指定します。

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

<< 1 2 3 > >>

別のキーワード

種類

クラス

モジュール

キーワード

検索結果

先頭5件

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

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

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (27904.0)

RDoc::Markdown.parse(markdown) -> RDoc::Markup::Document (27904.0)

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (27604.0)

RDoc::Parser.parsers -> [[Regexp, RDoc::Parser]] (27604.0)

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

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

RDoc::Generator::JsonIndex#generate -> () (27304.0)

RDoc::Generator::RI#generate -> () (27304.0)

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

RDoc::Parser.can_parse(file_name) -> RDoc::Parser | nil (27304.0)

RDoc::Parser::Markdown#scan -> RDoc::TopLevel (27304.0)

RDoc::Parser::Markdown (27004.0)

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

RDoc::Context#classes -> [RDoc::SingleClass | RDoc::NormalClass] (18904.0)

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (18904.0)

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

RDoc::TopLevel.find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil (18904.0)

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

RDoc::Context#aliases -> [RDoc::Alias] (18604.0)

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

RDoc::Context#constants -> [RDoc::Constant] (18604.0)

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

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

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

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

RDoc::Options#option_parser -> OptionParser | nil (18604.0)

RDoc::Options#parse(argv) -> () (18604.0)

RDoc::Options#show_all=(val) (18604.0)

RDoc::TopLevel#file_stat -> File::Stat (18604.0)

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

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

RDoc::Context#find_local_symbol(symbol) (18352.0)

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

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

RDoc::ATTR_MODIFIERS -> [String] (18307.0)

RDoc::CLASS_MODIFIERS -> [String] (18307.0)

RDoc::CONSTANT_MODIFIERS -> [String] (18307.0)

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

RDoc::DOT_DOC_FILENAME -> ".document" (18307.0)

RDoc::GENERAL_MODIFIERS -> [String] (18307.0)

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

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

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

RDoc::CodeObject#parent_file_name -> String (18304.0)

RDoc::CodeObject#parent_name -> String (18304.0)

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

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

RDoc::Context#add_alias(an_alias) -> RDoc::Alias (18304.0)

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

RDoc::Context#add_class(class_type, name, superclass) -> RDoc::SingleClass | RDoc::NormalClass (18304.0)

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

RDoc::Context#add_constant(const) -> () (18304.0)

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

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

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

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

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

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

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

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

RDoc::Context#name -> String (18304.0)

RDoc::Context#record_location(toplevel) (18304.0)

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

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

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

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

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

RDoc::Generator::RI#initialize(store, options) -> RDoc::Generator::RI (18304.0)

RDoc::KNOWN_CLASSES -> {String => String} (18304.0)

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

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