ライブラリ
- ビルトイン (1)
-
rake
/ rdoctask (1) -
rdoc
/ code _ object (1) -
rdoc
/ context (2) -
rdoc
/ generator / json _ index (1) -
rdoc
/ markdown (3) -
rdoc
/ markup (1) -
rdoc
/ markup / formatter (1) -
rdoc
/ markup / to _ ansi (1) -
rdoc
/ markup / to _ bs (1) -
rdoc
/ markup / to _ html (1) -
rdoc
/ markup / to _ html _ crossref (1) -
rdoc
/ markup / to _ rdoc (1) -
rdoc
/ parser (4) -
rdoc
/ parser / c (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / simple (1) -
rdoc
/ rdoc (1) -
rdoc
/ stats (1) -
rdoc
/ top _ level (4) -
rubygems
/ doc _ manager (5)
クラス
-
Gem
:: DocManager (5) -
RDoc
:: CodeObject (1) -
RDoc
:: Context (1) -
RDoc
:: Context :: Section (1) -
RDoc
:: Generator :: JsonIndex (1) -
RDoc
:: Markdown (3) -
RDoc
:: Markup (1) -
RDoc
:: Markup :: Formatter (1) -
RDoc
:: Markup :: ToAnsi (1) -
RDoc
:: Markup :: ToBs (1) -
RDoc
:: Markup :: ToHtml (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Markup :: ToRdoc (1) -
RDoc
:: Parser (4) -
RDoc
:: Parser :: C (1) -
RDoc
:: Parser :: Ruby (1) -
RDoc
:: Parser :: Simple (1) -
RDoc
:: RDoc (1) -
RDoc
:: Stats (1) -
RDoc
:: TopLevel (4) -
Rake
:: RDocTask (1)
オブジェクト
- main (1)
キーワード
-
add
_ generator (1) -
alias
_ extension (1) -
all
_ classes _ and _ modules (1) -
can
_ parse (1) -
configured
_ args (1) -
configured
_ args= (1) - extension (1)
-
find
_ class _ named (1) -
load
_ rdoc (1) - new (19)
- parse (1)
-
parser
_ for (1) - parsers (1)
- reset (1)
-
update
_ ri _ cache (1) - using (1)
検索結果
先頭5件
- RDoc
:: Markup :: ToRdoc . new(markup = nil) -> RDoc :: Markup :: ToRdoc - Gem
:: DocManager . load _ rdoc - RDoc
:: RDoc . add _ generator(klass) -> klass - RDoc
:: TopLevel . all _ classes _ and _ modules -> [RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule] - RDoc
:: TopLevel . find _ class _ named(name) -> RDoc :: NormalClass | RDoc :: SingleClass | nil
-
RDoc
:: Markup :: ToRdoc . new(markup = nil) -> RDoc :: Markup :: ToRdoc (18625.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
Gem
:: DocManager . load _ rdoc (18421.0) -
Gem の RDoc が使用可能な場合は使用します。 そうでない場合は、標準添付の RDoc を使用します。
Gem の RDoc が使用可能な場合は使用します。
そうでない場合は、標準添付の RDoc を使用します。
@raise Gem::DocumentError RDoc が使用できない場合に発生します。 -
RDoc
:: RDoc . add _ generator(klass) -> klass (18022.0) -
引数 klass で指定したクラスをジェネレータとして登録します。
引数 klass で指定したクラスをジェネレータとして登録します。
@param klass 登録するクラスを指定します。
@see c:RDoc::Options#custom_options -
RDoc
:: TopLevel . all _ classes _ and _ modules -> [RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule] (9961.0) -
RDoc が収集したクラス、モジュールを配列で返します。
RDoc が収集したクラス、モジュールを配列で返します。 -
RDoc
:: TopLevel . find _ class _ named(name) -> RDoc :: NormalClass | RDoc :: SingleClass | nil (9658.0) -
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。
@param name クラス名を文字列で指定します。 -
Rake
:: RDocTask . new(name = :rdoc) {|pkg| . . . } -> Rake :: RDocTask (9655.0) -
自身を初期化して RDoc タスクを定義します。
自身を初期化して RDoc タスクを定義します。
ブロックが与えられた場合は、自身をブロックパラメータとして
ブロックを評価します。
@param name タスクの名前を指定します。 -
RDoc
:: Generator :: JsonIndex . new(parent _ generator , options) -> RDoc :: Generator :: JsonIndex (9409.0) -
RDoc::Generator::JsonIndex オブジェクトを初期化します。
RDoc::Generator::JsonIndex オブジェクトを初期化します。
@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。
@... -
RDoc
:: Parser . parser _ for(top _ level , file _ name , body , options , stats) -> RDoc :: Parser (9409.0) -
file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
file_name を解析できるパーサのインスタンスを返します。
見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Parser :: C . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: C (9361.0) -
自身を初期化します。
自身を初期化します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Parser :: Ruby . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: Ruby (9361.0) -
自身を初期化します。
自身を初期化します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Parser :: Simple . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: Simple (9361.0) -
自身を初期化します。
自身を初期化します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body 内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Markdown . parse(markdown) -> RDoc :: Markup :: Document (9355.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。 -
RDoc
:: Parser . parsers -> [[Regexp , RDoc :: Parser]] (9355.0) -
RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ スの配列の配列を返します。
RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ
スの配列の配列を返します。 -
RDoc
:: Context :: Section . new(parent , title , comment) -> RDoc :: Context :: Section (9325.0) -
自身を初期化します。
自身を初期化します。
@param parent RDoc::Context オブジェクトを指定します。
@param title section のタイトルを文字列で指定します。
@param comment section のコメントを文字列で指定します。
また、section のシーケンス番号を新しく作成します。 -
RDoc
:: Markup . new(attribute _ manager = nil) -> RDoc :: Markup (9325.0) -
自身を初期化します。
自身を初期化します。
@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。 -
RDoc
:: Markup :: Formatter . new(markup = nil) -> RDoc :: Markup :: Formatter (9325.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToAnsi . new(markup = nil) -> RDoc :: Markup :: ToAnsi (9325.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToBs . new(markup = nil) -> RDoc :: Markup :: ToBs (9325.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToHtmlCrossref . new(path , context , show _ hash) -> RDoc :: Markup :: ToHtmlCrossref (9325.0) -
自身を初期化します。
自身を初期化します。
@param path 生成するファイルのパスを文字列で指定します。
@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。
@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。
@raise ArgumentError path に nil を指定した場合に発生します。 -
RDoc
:: CodeObject . new -> RDoc :: CodeObject (9307.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Context . new -> RDoc :: Context (9307.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Markup :: ToHtml . new -> RDoc :: Markup :: ToHtml (9307.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Parser . can _ parse(file _ name) -> RDoc :: Parser | nil (9307.0) -
file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。
file_name を解析できるパーサクラスを返します。見つからなかった場合は
nil を返します。
@param file_name 解析するファイルの名前を指定します。 -
RDoc
:: Stats . new -> RDoc :: Stats (9307.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: TopLevel . new(file _ name) -> RDoc :: TopLevel (9307.0) -
自身を初期化します。
自身を初期化します。
@param file_name ファイル名を文字列で指定します。 -
RDoc
:: TopLevel . reset -> () (9100.0) -
RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ ル)をクリアします。
RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ
ル)をクリアします。 -
RDoc
:: Markdown . new(extensions = DEFAULT _ EXTENSIONS , debug = false) (9052.0) -
引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ ジェクトを初期化します。
引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ
ジェクトを初期化します。
@param extensions 有効にする拡張を Symbol の配列で指定します。
@param debug デバッグを有効にするかどうかを指定します。 -
RDoc
:: Markdown . extension(name) -> nil (9004.0) -
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定 義します。
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定
義します。
ライブラリ内部で使用します。 -
RDoc
:: Parser . alias _ extension(old _ ext , new _ ext) -> bool (9004.0) -
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登
録します。
@param old_ext 拡張子を文字列で指定します。
@param new_ext 拡張子を文字列で指定します。
@return エイリアスが登録された場合は true を返します。old_ext にパーサ
が登録されていない場合、エイリアスが登録されずに false を返しま
す。 -
Gem
:: DocManager . new(spec , rdoc _ args = "") -> Gem :: DocManager (343.0) -
自身を初期化します。
自身を初期化します。
@param spec ドキュメントを生成する対象の Gem::Specification のインスタンスを指定します。
@param rdoc_args RDoc に渡すオプションを指定します。 -
Gem
:: DocManager . configured _ args -> Array (52.0) -
RDoc に渡す引数を返します。
RDoc に渡す引数を返します。 -
Gem
:: DocManager . configured _ args=(args) (52.0) -
RDoc に渡す引数をセットします。
RDoc に渡す引数をセットします。
@param args 文字列の配列か空白区切りの文字列を指定します。 -
Gem
:: DocManager . update _ ri _ cache (52.0) -
RDoc 2 がインストールされている場合は RI のキャッシュを更新します。 そうでない場合は何もしません。
RDoc 2 がインストールされている場合は RI のキャッシュを更新します。
そうでない場合は何もしません。 -
main
. using(module) -> self (22.0) -
引数で指定したモジュールで定義された拡張を有効にします。
引数で指定したモジュールで定義された拡張を有効にします。
有効にした拡張の有効範囲については以下を参照してください。
* https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html#label-Scope
@param module 有効にするモジュールを指定します。
//emlist[例][ruby]{
module Sloth
refine String do
def downcase
self
end
end
end
"ABC".downcase # => "abc"...