クエリ:rdoc > ライブラリ:rdoc > 種類:インスタンスメソッド > バージョン:3.4

203件ヒット [1-100件を表示] （0.029秒）

トップページ >

:rdoc

:インスタンスメソッド

:3.4

別のキーワード

クラス

モジュール

RDoc::Text (8)

キーワード

検索結果

<< 1 2 3 > >>

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

RDoc::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (10006.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 (10006.0)

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

@see RDoc::Context#add_class...

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

引数で指定したクラスを追加します。

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

RDoc::Parser::Simple#scan -> RDoc::TopLevel (9376.0)

インスタンスメソッド

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析します。

...自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。

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

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

インスタンスメソッド

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

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

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

@see RDoc::Text#normalize_comment...

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Context#sections -> RDoc::Context::Section (9358.0)

インスタンスメソッド

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

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

RDoc::Context#toplevel -> RDoc::TopLevel (9358.0)

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

RDoc::Parser::C#scan -> RDoc::TopLevel (9328.0)

インスタンスメソッド

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメントを解析します。

...C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Parser::RD#scan -> RDoc::TopLevel (9328.0)

インスタンスメソッド

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

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

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

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (9328.0)

インスタンスメソッド

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

...Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

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

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

インスタンスメソッド

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

RDoc::CodeObject#section -> RDoc::Context::Section (9310.0)

インスタンスメソッド

所属している section を返します。

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

インスタンスメソッド

現在の section を返します。

絞り込み条件を変える

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

インスタンスメソッド

find a module at a higher scope

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (9139.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#add_to(array, thing) -> () (9133.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#add_require(a_require) -> () (9121.0)

インスタンスメソッド

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

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

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

RDoc::CodeObject#start_doc -> () (9109.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::CodeObject#stop_doc -> () (9109.0)

インスタンスメソッド

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

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

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

@see RDoc::CodeObject#star...

RDoc::Text#normalize_comment(text) -> String (9079.0)

インスタンスメソッド

引数から行頭のスペースや改行文字などを削除します。

...から行頭のスペースや改行文字などを削除します。

詳しくは [SEE ALSO] の各メソッドを参照してください。

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

@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines...

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

RDoc::Markup::Formatter#add_tag(name, start, stop) -> () (9061.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::CodeObject#remove_classes_and_modules -> () (9055.0)

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

RDoc::Options#write_options -> object (9055.0)

インスタンスメソッド

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式で保存します。

...カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。...

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

インスタンスメソッド

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

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

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

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

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

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

インスタンスメソッド

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

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

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

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

RDoc::Markup#add_html(tag, name) -> () (9043.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) -> () (9043.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) -> () (9043.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::Parser#parse_files_matching(regexp) -> () (9043.0)

インスタンスメソッド

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

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

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

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

例:

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

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self...

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children...

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent...

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent...

RDoc::CodeObject#section=(val) (9025.0)

インスタンスメソッド

所属する section を設定します。

...所属する section を設定します。

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

@see SM::SimpleMarkup#convert...

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

インスタンスメソッド

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

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

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

RDoc::Options#verbosity=(val) (9025.0)

インスタンスメソッド

プログラムの解析時に表示する情報の詳細さを数値で指定します。

...プログラムの解析時に表示する情報の詳細さを数値で指定します。

@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。

@see RDoc::Options#verbosity...

RDoc::CodeObject#comment -> String (9007.0)

インスタンスメソッド

自身のコメントを返します。

絞り込み条件を変える

RDoc::CodeObject#comment=(comment) (9007.0)

インスタンスメソッド

自身のコメントを comment に設定します。

自身のコメントを comment に設定します。

ただし、comment が空文字列だった場合は何もしません。

@param comment コメントを文字列で指定します。

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

RDoc::Context#defined_in?(file) (9007.0)

インスタンスメソッド

Return true if at least part of this thing was defined in file

絞り込み条件を変える

RDoc::Context#find_local_symbol(symbol) (9007.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#find_symbol(symbol, method=nil) (9007.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::Context#in_files (9007.0)

インスタンスメソッド

Files this context is found in

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

自身の名前を返します。

自身の名前を返します。

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

RDoc::Context#ongoing_visibility=(vis) (9007.0)

インスタンスメソッド

Change the default visibility for new methods

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

インスタンスメソッド

Record the file that we happen to find it in

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

インスタンスメソッド

Handle sections

RDoc::Context#visibility -> :public | :protected | :private (9007.0)

インスタンスメソッド

自身の可視性を Symbol で返します。

絞り込み条件を変える

RDoc::Context::Section#comment -> String | nil (9007.0)

インスタンスメソッド

section のコメントを返します。

RDoc::Context::Section#inspect -> String (9007.0)

インスタンスメソッド

自身の情報を人間に読みやすい文字列にして返します。

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

インスタンスメソッド

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

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

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

RDoc::Context::Section#set_comment(comment) -> () (9007.0)

インスタンスメソッド

自身にコメントを設定します。

自身にコメントを設定します。

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

comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。

# ---------------------
# :section: The title
# The body
# ---------------------

RDoc::Context::Section#title -> String | nil (9007.0)

インスタンスメソッド

section のタイトルを返します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

RDoc::Markdown#css -> bool (9007.0)

インスタンスメソッド

CSS を記述した場合に出力に含めるかどうかを返します。

CSS を記述した場合に出力に含めるかどうかを返します。

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

絞り込み条件を変える

<< 1 2 3 > >>

別のキーワード

クラス

モジュール

キーワード

検索結果

先頭5件

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Parser::Simple#scan -> RDoc::TopLevel (9376.0)

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Context#sections -> RDoc::Context::Section (9358.0)

RDoc::Context#toplevel -> RDoc::TopLevel (9358.0)

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

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

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

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

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

RDoc::Parser::C#scan -> RDoc::TopLevel (9328.0)

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

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

RDoc::Parser::RD#scan -> RDoc::TopLevel (9328.0)

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (9328.0)

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

RDoc::CodeObject#section -> RDoc::Context::Section (9310.0)

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

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

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

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

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

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

RDoc::CodeObject#stop_doc -> () (9109.0)

RDoc::Text#normalize_comment(text) -> String (9079.0)

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

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

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

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

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

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

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

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

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

RDoc::Options#write_options -> object (9055.0)

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

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

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

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

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

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

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

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

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

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

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

RDoc::CodeObject#section=(val) (9025.0)

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

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

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

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

RDoc::Options#verbosity=(val) (9025.0)