クエリ:d > ライブラリ:rdoc > バージョン:3.1

302件ヒット [1-100件を表示] （0.125秒）

トップページ >

:rdoc

:3.1

別のキーワード

種類

クラス

モジュール

RDoc (8)
RDoc::Text (8)

キーワード

検索結果

<< 1 2 3 ... > >>

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

定数

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

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

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self...

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

インスタンスメソッド

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

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

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

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

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

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children...

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

RDoc::CodeObject#start_doc -> () (27304.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 -> () (27304.0)

インスタンスメソッド

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

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

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

@see RDoc::CodeObject#star...

RDoc::Markdown#definition_lists -> bool (27304.0)

インスタンスメソッド

定義リストを解釈するかどうかを返します。

定義リストを解釈するかどうかを返します。

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

絞り込み条件を変える

RDoc::Markdown#definition_lists=(val) (27304.0)

インスタンスメソッド

定義リストを解釈するかどうかを設定します。

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

定数

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

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

インスタンスメソッド

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

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

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

RDoc::RDoc.add_generator(klass) -> klass (27304.0)

特異メソッド

引数 klass で指定したクラスをジェネレータとして登録します。

...引数 klass で指定したクラスをジェネレータとして登録します。

@param klass 登録するクラスを指定します。

@see c:RDoc::Options#custom_options...

RDoc::Markdown (27004.0)

クラス

Markdown 形式で記述されたドキュメントを rdoc 上で解析するためのクラスです。

...Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
クラスです。...

絞り込み条件を変える

RDoc::Markup::ToRdoc (27004.0)

クラス

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるためのクラスです。

...RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。...

RDoc::Parser::Markdown (27004.0)

クラス

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

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

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

RDoc::RDoc (27004.0)

クラス

rdoc ドキュメントの作成を行うクラスです。

...rdoc ドキュメントの作成を行うクラスです。

以下のようにして、rdoc コマンドを実行するのと同様に実行します。

require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)

args には rdoc コマンドに渡すのと同様の引数を文字列...

...の配列で指定します。

rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。...

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

インスタンスメソッド

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

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

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

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

特異メソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

RDoc::Markdown.new(extensions = DEFAULT_EXTENSIONS, debug = false) (18604.0)

特異メソッド

引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブジェクトを初期化します。

...引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ
ジェクトを初期化します。

@param extensions 有効にする拡張を Symbol の配列で指定します。

@param debug デバッグを有効にするかどうかを指定します。...

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

特異メソッド

自身を初期化します。

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

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

絞り込み条件を変える

RDoc::Options#encoding -> Encoding (18604.0)

インスタンスメソッド

コマンドライン引数の --encoding オプションを指定していた場合、指定したエンコーディングに対応する Encoding オブジェクトを返します。

コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。

指定しなかった場合は Encoding.default_external の値を返します。

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

定数

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

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

定数

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

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

定数

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

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

定数

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

絞り込み条件を変える

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

定数

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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_method(a_method) -> () (18304.0)

インスタンスメソッド

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

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

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

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_require(a_require) -> () (18304.0)

インスタンスメソッド

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

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

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

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#defined_in?(file) (18304.0)

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

インスタンスメソッド

find a module at a higher scope

RDoc::Context#find_local_symbol(symbol) (18304.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_module_named(name) -> RDoc::NormalModule | nil (18304.0)

インスタンスメソッド

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

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

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

RDoc::Context#find_symbol(symbol, method=nil) (18304.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#initialize_classes_and_modules -> () (18304.0)

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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::Generator::Darkfish::GENERATOR_DIR -> String (18304.0)

定数

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

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

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

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

定数

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

RDoc::Generator::RI::DESCRIPTION -> String (18304.0)

定数

このジェネレータの説明を表す文字列です。

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_special(pattern, name) -> () (18304.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) -> () (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::Options#diagram -> bool (18304.0)

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

RDoc::Options#finish_page_dir (18304.0)

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。

@return 設定されたディレクトリを文字列で返します。

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

インスタンスメソッド

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

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

@param val 設定するディレクトリを文字列で指定します。

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを返します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。

オプションの解析前は nil を返します。

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

インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを設定します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。

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

RDoc::Options::DEPRECATED -> {String -> String} (18304.0)

定数

非推奨のオプションの一覧を返します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースになるように置き換えます。

引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな
るように置き換えます。

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

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

インスタンスメソッド

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

特異メソッド

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

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

絞り込み条件を変える

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

特異メソッド

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

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

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

RDoc (18007.0)

モジュール

rdoc ドキュメントを扱うためのモジュールです。

...rdoc ドキュメントを扱うためのモジュールです。...

RDoc::AnyMethod (18004.0)

クラス

メソッドを表現するクラスの基本クラスです。

メソッドを表現するクラスの基本クラスです。

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

RDoc::ClassModule (18004.0)

クラス

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

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

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

RDoc::CodeObject (18004.0)

クラス

RDoc のコードツリーを表現するクラスの基本クラスです。

...RDoc のコードツリーを表現するクラスの基本クラスです。

以下は RDoc::CodeObject のサブクラスのツリーです。

//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RD...

...oc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
* RDoc::Alias
* RDoc::Attr
* RDoc::Constant
* RDoc::Require
* RDoc::Include
//}...

絞り込み条件を変える

RDoc::Generator::Darkfish (18004.0)

クラス

HTML を生成するためのクラスです。

RDoc::Generator::JsonIndex (18004.0)

クラス

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデックスを生成するクラスです。

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するクラスです。

RDoc::GhostMethod (18004.0)

クラス

コメントでのみ参照されるメソッドを表現します。

コメントでのみ参照されるメソッドを表現します。

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

RDoc::Include (18004.0)

クラス

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

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

<< 1 2 3 ... > >>

別のキーワード

種類

クラス

モジュール

キーワード

検索結果

先頭5件

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

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

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

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

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

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

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

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

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

RDoc::Markdown#definition_lists -> bool (27304.0)

RDoc::Markdown#definition_lists=(val) (27304.0)

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

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

RDoc::RDoc.add_generator(klass) -> klass (27304.0)

RDoc::Markdown (27004.0)

RDoc::Markup::ToRdoc (27004.0)

RDoc::Parser::Markdown (27004.0)

RDoc::RDoc (27004.0)

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

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

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

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

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

RDoc::Markdown.new(extensions = DEFAULT_EXTENSIONS, debug = false) (18604.0)

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

RDoc::Options#encoding -> Encoding (18604.0)

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

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

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

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

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

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

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

RDoc::CodeObject#remove_methods_etc -> () (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_method(a_method) -> () (18304.0)

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

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

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

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

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

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

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

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

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

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

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

RDoc::Context#method_list -> [RDoc::AnyMethod] (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::Generator::Darkfish::GENERATOR_DIR -> String (18304.0)

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

RDoc::Generator::RI::DESCRIPTION -> String (18304.0)

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

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

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

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

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

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

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

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

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

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

RDoc::Options#finish_page_dir (18304.0)

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

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

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