るりまサーチ (Ruby 2.4.0)

最速Rubyリファレンスマニュアル検索！
77件ヒット [1-77件を表示] （0.049秒）
トップページ > バージョン:2.4.0[x] > クエリ:rdoc[x] > クエリ:Text[x]

別のキーワード

  1. rdoc version
  2. rdoc/context new
  3. rdoc attr_modifiers
  4. rdoc class_modifiers
  5. rdoc/markdown parse

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

  1. rdoc
  2. RDoc::Parser::Text
  3. RDoc::Text
  4. rdoc/context
  5. rdoc/parser/text

rdoc (115411.0)

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ...

RDoc::Parser::Text (63073.0)

プログラムを含まないテキストを解析するためのクラスです。

プログラムを含まないテキストを解析するためのクラスです。

単体では使用せず、RDoc::Parser のサブクラスで RDoc::Parser::Text
を include する事で、プログラムを含んでいない事を rdoc に伝えます。

RDoc::Text (63001.0)

コメントテキストを処理するためのクラスです。

コメントテキストを処理するためのクラスです。

rdoc/context (36097.0)

RDoc::Context と RDoc::Context::Section を定義するサブライ ブラリです。

RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。

rdoc/parser/text (36001.0)

プログラムを含まないテキストを解析するためのサブライブラリです。

プログラムを含まないテキストを解析するためのサブライブラリです。

絞り込み条件を変える

rdoc/text (36001.0)

コメントテキストを処理するためのサブライブラリです。

コメントテキストを処理するためのサブライブラリです。

RDoc::Context (27049.0)

モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す るクラスを管理するクラスです。

モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す
るクラスを管理するクラスです。

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

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

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

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

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

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

@param su...

RDoc::Context#add_module(class_type, name) -> RDoc::NormalModule | RDoc::SingleClass | RDoc::NormalClass (18982.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] (18946.0)

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

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

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

絞り込み条件を変える

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

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

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

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

@see RDoc::Text#normalize_comment

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Context::Section.new(parent, title, comment) -> RDoc::Context::Section (18622.0)

自身を初期化します。

自身を初期化します。

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

@param title section のタイトルを文字列で指定します。

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

また、section のシーケンス番号を新しく作成します。

絞り込み条件を変える

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

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

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

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

現在の section を返します。

現在の section を返します。

RDoc::Context.new -> RDoc::Context (18604.0)

自身を初期化します。

自身を初期化します。

RDoc::Text#normalize_comment(text) -> String (18466.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_alias(an_alias) -> RDoc::Alias (18370.0)

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Text#flush_left(text) -> String (18322.0)

引数から各行の行頭のスペースを削除します。

引数から各行の行頭のスペースを削除します。

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

絞り込み条件を変える

RDoc::Text#markup(text) -> String (18322.0)

引数を整形します。

引数を整形します。

include したクラスに self#formatter メソッドが必要です。

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

RDoc::Text#strip_hashes(text) -> String (18322.0)

引数から各行の行頭の # を削除します。

引数から各行の行頭の # を削除します。

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

RDoc::Text#strip_newlines(text) -> String (18322.0)

引数から先頭と末尾の改行を削除します。

引数から先頭と末尾の改行を削除します。

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

RDoc::Text#strip_stars(text) -> String (18322.0)

引数から /* 〜 */ 形式のコメントを削除します。

引数から /* 〜 */ 形式のコメントを削除します。

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

rdoc/markdown (18319.0)

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

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

詳しくは以下を参照してください。

* https://daringfireball.net/projects/markdown/syntax

Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考に プロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな...

絞り込み条件を変える

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

find a module at a higher scope

find a module at a higher scope

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (18133.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) -> () (18127.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) -> () (18115.0)

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

RDoc::Context#find_local_symbol(symbol) (18001.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) (18001.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 (18001.0)

Files this context is found in

Files this context is found in

絞り込み条件を変える

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

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

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

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

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

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

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

自身の名前を返します。

自身の名前を返します。

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

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

Change the default visibility for new methods

Change the default visibility for new methods

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

Record the file that we happen to find it in

Record the file that we happen to find it in

絞り込み条件を変える

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

Handle sections

Handle sections

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

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

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

RDoc::Context::Section (18001.0)

section に関する情報を保持するクラスです。

section に関する情報を保持するクラスです。

ドキュメント中で以下のように記述した情報を保持しています。

# :section: The title
# The body

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Context::TYPES -> ["class", "instance"] (18001.0)

メソッドの種類を文字列の配列で返します。

メソッドの種類を文字列の配列で返します。

RDoc::Context::VISIBILITIES -> [:public, :protected, :private] (18001.0)

メソッドの可視性を Symbol の配列で返します。

メソッドの可視性を Symbol の配列で返します。

絞り込み条件を変える

RDoc::Markup::ToHtmlCrossref.new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref (9622.0)

自身を初期化します。

自身を初期化します。

@param path 生成するファイルのパスを文字列で指定します。

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

@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。

@raise ArgumentError path に nil を指定した場合に発生します。

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

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

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

RDoc::Markup (9193.0)

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

例:

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

独自のフォーマットを行うようにパーサを拡張する事もできます。


例:

require 'rdoc/markup'
require 'rdoc/markup/to_html'

class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
...

RDoc::Markup#add_special(pattern, name) -> () (9055.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 '...

NEWS for Ruby 2.1.0 (163.0)

NEWS for Ruby 2.1.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

NEWS for Ruby 2.1.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。

== 2.0.0 以降の変更

=== 言語仕様の変更

* キーワード引数のデフォルト値が省略可能になりました。これらの「必須キーワード引数」は呼び出し時に明示的に与えなければなりません。

* 整数や小数のリテラルの末尾に'r','i','...

絞り込み条件を変える

ruby 1.8.4 feature (109.0)

ruby 1.8.4 feature ruby 1.8.4 での ruby 1.8.3 からの変更点です。

ruby 1.8.4 feature
ruby 1.8.4 での ruby 1.8.3 からの変更点です。

掲載方針

*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。

以下は各変更点に付けるべきタグです。

記号について(特に重要なものは大文字(主観))

# * カテゴリ
# * [ruby]: ruby インタプリタの変更
# * [api]: 拡張ライブラリ API
# * [lib]: ライブラリ
* レベル
* [bug]: バグ修正
* [new]: 追加され...

cgi/session (91.0)

CGI のセッション管理を行うライブラリ。

CGI のセッション管理を行うライブラリ。

セッションとは、HTTP の一連のリクエストとレスポンスが属するべき
コンテクスト (状況) のことをいいます。
セッション管理には従来通り cgi ライブラリが提供する
クッキーを使用してもいいですが、
この cgi/session を使用した方がよりわかりやすいでしょう。
セッション情報は Hash ライクなインターフェースです。

セッションはセッション ID とプログラムが記録した
セッション情報から構成されます。
デフォルトでは CGI::Session::FileStore が使用され、
記録できるのは文字列のみです。

セッション情報...

検索対象のドキュメントは るりまプロジェクト の成果物です。

検索エンジンは Groonga 13.0.0 を使っています。

Groongaは Rroonga 12.1.0 経由で利用しています。

Powered by Ruby 3.1.2.

るりまサーチのリポジトリ は GitHub 上にあります。