別のキーワード
ライブラリ
- ビルトイン (3)
-
rake
/ rdoctask (2) -
rdoc
/ generator / darkfish (2) -
rdoc
/ generator / json _ index (1) -
rdoc
/ markdown (2) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup (4) -
rdoc
/ markup / formatter (1) -
rdoc
/ markup / to _ html (2) -
rdoc
/ markup / to _ html _ crossref (2) -
rdoc
/ rdoc (1)
クラス
- Module (2)
-
RDoc
:: Generator :: Darkfish (1) -
RDoc
:: Markdown (3) -
RDoc
:: Markup (3) -
RDoc
:: Markup :: Formatter (1) -
RDoc
:: Markup :: ToHtml (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Options (2) -
Rake
:: RDocTask (2)
オブジェクト
- main (1)
キーワード
- Darkfish (1)
-
HTML
_ ENTITIES (1) - JsonIndex (1)
- Markup (1)
-
NEWS for Ruby 2
. 0 . 0 (1) -
NEWS for Ruby 2
. 1 . 0 (1) -
NEWS for Ruby 2
. 2 . 0 (1) - RDoc (1)
- Ruby用語集 (1)
- ToHtml (1)
- ToHtmlCrossref (1)
-
add
_ html (1) -
add
_ special (1) -
add
_ tag (1) -
add
_ word _ pair (1) -
cgi
/ session (1) - drb (1)
- generate (1)
- generator (1)
- html= (1)
- new (2)
-
rdoc
/ generator (1) -
rdoc
/ generator / darkfish (1) -
rdoc
/ generator / json _ index (1) -
rdoc
/ markdown (1) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup (1) -
rdoc
/ markup / to _ html (1) -
rdoc
/ markup / to _ html _ crossref (1) -
rdoc
/ parser / changelog (1) -
rdoc
_ dir (1) -
rdoc
_ dir= (1) - refine (1)
-
ruby 1
. 8 . 2 feature (1) -
ruby 1
. 8 . 4 feature (1) - rubygems (1)
- template (1)
- using (2)
検索結果
先頭5件
-
rdoc (115231.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
RDoc
:: Markdown # html -> bool (63352.0) -
HTML を記述した場合にそのまま出力するかどうかを返します。
HTML を記述した場合にそのまま出力するかどうかを返します。
デフォルトでは true を返します。 -
rdoc
/ markup / to _ html (36151.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
require 'rdoc/markup/to_html'
h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。 -
rdoc
/ markup / to _ html _ crossref (36115.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。 -
RDoc
:: Markdown :: HTML _ ENTITIES -> {String => [Integer]} (27400.0) -
HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。
HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。 -
Rake
:: RDocTask # rdoc _ dir -> String (27400.0) -
作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。
作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。 -
RDoc
:: Markup # add _ html(tag , name) -> () (27376.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
:: Markdown # html=(val) (27352.0) -
HTML を記述した場合にそのまま出力するかどうかを設定します。
HTML を記述した場合にそのまま出力するかどうかを設定します。 -
Rake
:: RDocTask # rdoc _ dir=(dir) (27352.0) -
作成した HTML ファイルを保存するディレクトリ名をセットします。
作成した HTML ファイルを保存するディレクトリ名をセットします。 -
RDoc
:: RDoc (27247.0) -
rdoc ドキュメントの作成を行うクラスです。
rdoc ドキュメントの作成を行うクラスです。
以下のようにして、rdoc コマンドを実行するのと同様に実行します。
require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)
args には rdoc コマンドに渡すのと同様の引数を文字列の配列で指定します。
rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。 -
RDoc
:: Markup :: ToHtml (27097.0) -
RDoc 形式のドキュメントを HTML に整形するクラスです。
RDoc 形式のドキュメントを HTML に整形するクラスです。 -
RDoc
:: Markup :: ToHtmlCrossref (27097.0) -
RDoc 形式のドキュメントを HTML に整形するクラスです。
RDoc 形式のドキュメントを HTML に整形するクラスです。 -
RDoc
:: Markup :: ToHtmlCrossref . new(path , context , show _ hash) -> RDoc :: Markup :: ToHtmlCrossref (18622.0) -
自身を初期化します。
自身を初期化します。
@param path 生成するファイルのパスを文字列で指定します。
@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。
@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。
@raise ArgumentError path に nil を指定した場合に発生します。 -
RDoc
:: Markup :: ToHtml . new -> RDoc :: Markup :: ToHtml (18604.0) -
自身を初期化します。
自身を初期化します。 -
rdoc
/ generator (18565.0) -
RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのサブライブラリです。
RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのサブライブラリです。
RDoc には HTML 向けのジェネレータの
RDoc::Generator::Darkfish と ri 向けのジェネレータの
RDoc::Generator::RI が付属しています。
=== ジェネレータの登録
RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。
class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
... -
rdoc
/ markdown (18337.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための サブライブラリです。
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。
詳しくは以下を参照してください。
* https://daringfireball.net/projects/markdown/syntax
Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考に プロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。
=== 拡張
以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな... -
rdoc
/ markup (18319.0) -
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。
=== Markup
基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレイン... -
rdoc
/ generator / json _ index (18139.0) -
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するサブライブラリです。
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するサブライブラリです。
This generator is derived from sdoc by Vladimir Kolesnikov and
contains verbatim code written by him.
このジェネレータは HTML ジェネレータと一緒に使うために設計されています。:
class RDoc::Generator::Darkfish
def initialize options
# ...
@base_dir = Pa... -
rdoc
/ parser / changelog (18073.0) -
ChangeLog ファイルを解析するためのサブライブラリです。
ChangeLog ファイルを解析するためのサブライブラリです。
ChangeLog ファイルを解析して、RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。
このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
参照)であれば解析できます。 -
rdoc
/ generator / darkfish (18049.0) -
HTML を生成するためのサブライブラリです。
HTML を生成するためのサブライブラリです。 -
rdoc
/ markdown / entities (18049.0) -
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。 -
RDoc
:: Markup (9229.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) -> () (9073.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 :: Formatter # add _ tag(name , start , stop) -> () (9073.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
:: Markup # add _ word _ pair(start , stop , name) -> () (9055.0) -
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。
@param start 開始となる文字列を指定します。
@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。
@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。
例:
require 'rdoc/markup/... -
RDoc
:: Generator :: Darkfish (9049.0) -
HTML を生成するためのクラスです。
HTML を生成するためのクラスです。 -
RDoc
:: Generator :: Darkfish # generate -> () (9049.0) -
解析した情報を HTML ファイルや検索用のインデックスに出力します。
解析した情報を HTML ファイルや検索用のインデックスに出力します。 -
RDoc
:: Generator :: JsonIndex (9049.0) -
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するクラスです。
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するクラスです。 -
RDoc
:: Options # generator -> Generator (9019.0) -
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。 -
RDoc
:: Options # template -> String (9019.0) -
コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。
コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。
指定しなかった場合は 'html' を返します。 -
cgi
/ session (325.0) -
CGI のセッション管理を行うライブラリ。
CGI のセッション管理を行うライブラリ。
セッションとは、HTTP の一連のリクエストとレスポンスが属するべき
コンテクスト (状況) のことをいいます。
セッション管理には従来通り cgi ライブラリが提供する
クッキーを使用してもいいですが、
この cgi/session を使用した方がよりわかりやすいでしょう。
セッション情報は Hash ライクなインターフェースです。
セッションはセッション ID とプログラムが記録した
セッション情報から構成されます。
デフォルトでは CGI::Session::FileStore が使用され、
記録できるのは文字列のみです。
セッション情報... -
NEWS for Ruby 2
. 0 . 0 (235.0) -
NEWS for Ruby 2.0.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
NEWS for Ruby 2.0.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。
== 1.9.3 以降の変更
=== 言語仕様の変更
* キーワード引数を追加しました
* %i, %I をシンボルの配列作成のために追加しました。(%w, %W に似ています)
* デフォルトのソースエンコーディングを US-ASCI... -
NEWS for Ruby 2
. 1 . 0 (127.0) -
NEWS for Ruby 2.1.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
...をサポート
* rinda
* Rinda::RingServer, Rinda::RingFinger
* マルチキャストソケットをサポート
* rubygems
* 2.2.0 に更新。 Notable new features include:
* Gemfile or gem.deps.rb support including Gem.file.lock (experimental)
* Improved, iterati... -
ruby 1
. 8 . 4 feature (127.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]: 追加され... -
rubygems (91.0)
-
RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。
RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。
===[a:gem_command] gem コマンドの使い方
$ gem help
RubyGems は Ruby のための高機能なパッケージ管理ツールです。
これはより多くの情報へのポインタを含んでいる基本的なヘルプメッセージです。
使用方法:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]
例:
... -
Module
# refine(klass) { . . . } -> Module (55.0) -
引数 klass で指定したクラスだけに対して、ブロックで指定した機能を提供で きるモジュールを定義します。定義した機能は Module#refine を使用せずに直 接 klass に対して変更を行う場合と異なり、限られた範囲のみ有効にできます。 そのため、既存の機能を局所的に修正したい場合などに用いる事ができます。
引数 klass で指定したクラスだけに対して、ブロックで指定した機能を提供で
きるモジュールを定義します。定義した機能は Module#refine を使用せずに直
接 klass に対して変更を行う場合と異なり、限られた範囲のみ有効にできます。
そのため、既存の機能を局所的に修正したい場合などに用いる事ができます。
refinements 機能の詳細については以下を参照してください。
* https://magazine.rubyist.net/articles/0041/0041-200Special-refinement.html
* https://docs.ruby-la... -
NEWS for Ruby 2
. 2 . 0 (55.0) -
NEWS for Ruby 2.2.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
...NEWS for Ruby 2.2.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリス... -
Ruby用語集 (55.0)
-
Ruby用語集 A B C D E F G I J M N O R S Y
Ruby用語集
A B C D E F G I J M N O R S Y
a ka sa ta na ha ma ya ra wa
=== 記号・数字
: %記法
: % notation
「%」記号で始まる多種多様なリテラル記法の総称。
参照:d:spec/literal#percent
: 0 オリジン
: zero-based
番号が 0 から始まること。
例えば、
Array や Vector、Matrix などの要素の番号、
String における文字の位置、
といったものは 0 オリジンである。
: 1 オリジン
: one-based
... -
drb (55.0)
-
分散オブジェクトプログラミングのためのライブラリです。
分散オブジェクトプログラミングのためのライブラリです。
Ruby のプロセスから他のRubyプロセスにあるオブジェクトのメソッド
を呼びだすことができます。他のマシン上のプロセスにも
アクセスできます。
=== 概要
dRuby は Ruby 専用の分散オブジェクトシステムです。
Ruby のみで記述され、TCP socket のような Ruby 本体が提供する
通信手段があれば追加のインストール物なしに利用可能です。
独自のプロトコルで通信し、他の分散オブジェクトシステム
(CORBA, RMI, .NETなど)との相互運用性はありません。
dRuby は
* 他のプロセスと Ru... -
ruby 1
. 8 . 2 feature (55.0) -
ruby 1.8.2 feature ruby 1.8.2 での ruby 1.8.1 からの変更点です。
ruby 1.8.2 feature
ruby 1.8.2 での ruby 1.8.1 からの変更点です。
掲載方針
*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。
以下は各変更点に付けるべきタグです。
*カテゴリ
* [ruby]: ruby インタプリタの変更
* [api]: 拡張ライブラリ API
* [lib]: ライブラリ
*レベル
* [bug]: バグ修正
* [new]: 追加されたクラス/メソッドなど
* [compat]: 変更されたクラス/... -
Module
# using(module) -> self (37.0) -
引数で指定したモジュールで定義された拡張を現在のクラス、モジュールで有 効にします。
引数で指定したモジュールで定義された拡張を現在のクラス、モジュールで有
効にします。
有効にした拡張の有効範囲については以下を参照してください。
* https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html#label-Scope
@param module 有効にするモジュールを指定します。
@see Module#refine, main.using -
main
. using(module) -> self (37.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"...