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

240件ヒット [1-100件を表示] （0.054秒）

トップページ >

:rdoc

:インスタンスメソッド

:3.1

別のキーワード

ライブラリ

クラス

モジュール

キーワード

検索結果

<< 1 2 3 > >>

Rake::RDocTask#rdoc_files -> Rake::FileList (27355.0)

インスタンスメソッド

RDoc の生成に使用するファイルリストを返します。デフォルトは空です。

RDoc の生成に使用するファイルリストを返します。
デフォルトは空です。

Rake::RDocTask#rdoc_files=(filelist) (27355.0)

インスタンスメソッド

RDoc の生成に使用するファイルリストをセットします。

RDoc の生成に使用するファイルリストをセットします。

@param filelist ファイルリストを指定します。

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

インスタンスメソッド

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

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

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

Rake::RDocTask#rdoc_dir -> String (27307.0)

インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名を返します。デフォルトは html です。

作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。

Rake::RDocTask#rdoc_dir=(dir) (27307.0)

インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名をセットします。

絞り込み条件を変える

Gem::Specification#has_rdoc? -> bool (18421.0)

インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

@see Gem::Specification#has_rdoc

Gem::Specification#has_rdoc -> bool (18403.0)

インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

Gem::DocManager#run_rdoc(*args) (18391.0)

インスタンスメソッド

与えられた引数を使用して RDoc を実行します。

与えられた引数を使用して RDoc を実行します。

@param args RDoc に与える引数を指定します。

@raise Gem::FilePermissionError RDoc でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。

Gem::DocManager#setup_rdoc (18373.0)

インスタンスメソッド

RDoc を実行するための準備を行います。

RDoc を実行するための準備を行います。

@raise Gem::FilePermissionError RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。

Gem::Specification#extra_rdoc_files=(paths) (18373.0)

インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。

絞り込み条件を変える

Gem::Specification#rdoc_options=(options) (18373.0)

インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。

Gem::DocManager#generate_rdoc (18355.0)

インスタンスメソッド

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

Gem::DocManager#install_rdoc (18355.0)

インスタンスメソッド

RDoc を生成してインストールします。

Gem::DocManager#rdoc_installed? -> bool (18355.0)

インスタンスメソッド

RDoc がインストール済みの場合は、真を返します。そうでない場合は偽を返します。

RDoc がインストール済みの場合は、真を返します。
そうでない場合は偽を返します。

Gem::Specification#extra_rdoc_files -> [String] (18355.0)

インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

絞り込み条件を変える

Gem::Specification#has_rdoc=(flag) (18355.0)

インスタンスメソッド

RDoc を生成するかどうかをセットします。デフォルトは偽です。

Gem::Specification#rdoc_options -> [String] (18355.0)

インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

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

インスタンスメソッド

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

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

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

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

指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリの
doc 以下に出力します。

インスタンスメソッド

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

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

インスタンスメソッド

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

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

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

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

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

@param su...

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

ただし、クラスとして既に同名のものが登録されていた場合は、何もせずにそ
のクラスを返します。

@param 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] (9949.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

@see RDoc::Text#normalize_comment

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

現在の section を返します。

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

インスタンスメソッド

find a module at a higher scope

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

インスタンスメソッド

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

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

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

@param visibility 可視性を :public, :protected, :private の内のいずれか
で指定します。

@param singleton 特異メソッドの可視性を変更する場合は...

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

インスタンスメソッド

array に thing を追加します。

array に thing を追加します。

@param array 配列を指定します。

@param 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_requ...

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

@see RDoc::CodeObject#end_doc

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

インスタンスメソッド

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

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

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

@see RDoc::CodeObject#start_doc

RDoc::Text#normalize_comment(text) -> String (9076.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) -> () (9070.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

Rake::RDocTask#options=(options) (9070.0)

インスタンスメソッド

rdoc コマンドに渡すオプションのリストをセットします。

rdoc コマンドに渡すオプションのリストをセットします。

@param options rdoc コマンドに渡されるオプションを指定します。

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

インスタンスメソッド

name で登録された規則で取得された文字列を start と stop で囲むように指定します。

name で登録された規則で取得された文字列を start と stop で囲むように指
定します。

@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。

@param start 開始の記号を文字列で指定します。

@param stop 終了の記号を文字列で指定します。

例:

require 'rdoc/markup/to_html'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup:...

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

Rake::RDocTask#external -> bool (9052.0)

インスタンスメソッド

この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。デフォルトは偽です。

この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。
デフォルトは偽です。

絞り込み条件を変える

Rake::RDocTask#external=(flag) (9052.0)

インスタンスメソッド

外部のシェル経由で rdoc コマンドを実行するかどうかセットします。

外部のシェル経由で rdoc コマンドを実行するかどうかセットします。

@param flag 真または偽を指定します。

Rake::RDocTask#name -> String (9052.0)

インスタンスメソッド

タスクの名前を返します。デフォルトは rdoc です。

Rake::RDocTask#option_list -> Array (9052.0)

インスタンスメソッド

rdoc コマンドに渡すオプションのリストを返します。

Rake::RDocTask#option_string -> String (9052.0)

インスタンスメソッド

rdoc コマンドに渡すオプションを文字列として返します。

Rake::RDocTask#options -> Array (9052.0)

インスタンスメソッド

rdoc コマンドに渡すオプションのリストを返します。

rdoc コマンドに渡すオプションのリストを返します。

指定できるオプションは -o, --main, --title, -T 以外です。

絞り込み条件を変える

Rake::RDocTask#template -> String (9052.0)

インスタンスメソッド

使用するテンプレートを返します。デフォルトは RDoc のデフォルトです。

使用するテンプレートを返します。
デフォルトは RDoc のデフォルトです。

Rake::RDocTask#title -> String (9052.0)

インスタンスメソッド

RDoc のタイトルを返します。デフォルト値はありません。

RDoc のタイトルを返します。
デフォルト値はありません。

Rake::RDocTask#title=(title) (9052.0)

インスタンスメソッド

RDoc のタイトルをセットします。

RDoc のタイトルをセットします。

@param title タイトルを指定します。

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

インスタンスメソッド

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

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

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

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

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

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

インスタンスメソッド

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

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

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

tag で指定したタグをフォーマットの対象にします。

tag で指定したタグをフォーマットの対象にします。

@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_ht...

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

インスタンスメソッド

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にします。

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま
す。

例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。

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

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require '...

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

インスタンスメソッド

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にします。

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。

@param start 開始となる文字列を指定します。

@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。

例:

require 'rdoc/markup/...

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

インスタンスメソッド

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

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

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

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

例:

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

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self

絞り込み条件を変える

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

@see SM::SimpleMarkup#convert

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

インスタンスメソッド

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

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

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

@see SM::SimpleMarkup#convert

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

@see RDoc::Options#verbosity

絞り込み条件を変える

<< 1 2 3 > >>

別のキーワード

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

Rake::RDocTask#rdoc_files -> Rake::FileList (27355.0)

Rake::RDocTask#rdoc_files=(filelist) (27355.0)

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

Rake::RDocTask#rdoc_dir -> String (27307.0)

Rake::RDocTask#rdoc_dir=(dir) (27307.0)

Gem::Specification#has_rdoc? -> bool (18421.0)

Gem::Specification#has_rdoc -> bool (18403.0)

Gem::DocManager#run_rdoc(*args) (18391.0)

Gem::DocManager#setup_rdoc (18373.0)

Gem::Specification#extra_rdoc_files=(paths) (18373.0)

Gem::Specification#rdoc_options=(options) (18373.0)

Gem::DocManager#generate_rdoc (18355.0)

Gem::DocManager#install_rdoc (18355.0)

Gem::DocManager#rdoc_installed? -> bool (18355.0)

Gem::Specification#extra_rdoc_files -> [String] (18355.0)

Gem::Specification#has_rdoc=(flag) (18355.0)

Gem::Specification#rdoc_options -> [String] (18355.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Rake::RDocTask#options=(options) (9070.0)

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

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

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

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