るりまサーチ (Ruby 2.6.0)

最速Rubyリファレンスマニュアル検索!
56件ヒット [1-56件を表示] (0.068秒)

別のキーワード

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

検索結果

rdoc/markup/to_rdoc (36070.0)

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

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

サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。

rdoc/rdoc (36052.0)

rdoc コマンドのためのサブライブラリです。

rdoc コマンドのためのサブライブラリです。

rdoc (19108.0)

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

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

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

rdoc/generator (18550.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/markup (18286.0)

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。

=== Markup

基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレイン...

絞り込み条件を変える

rdoc/markdown (18268.0)

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

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

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

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

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

=== 拡張

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

rake/rdoctask (18238.0)

ドキュメントを作成するためのタスクを定義します。

ドキュメントを作成するためのタスクを定義します。

以下のタスクを定義します。

: rdoc
RDoc を作成します。
: clobber_rdoc
生成された RDoc のファイルを削除します。
このタスクは clobber タスクにも追加されます。
: rerdoc
既に存在する RDoc が古くなくても RDoc を作成します。


例:
Rake::RDocTask.new do |rd|
rd.main = "README.rdoc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
...

rdoc/parser (18214.0)

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成
する事ができます。

* #initialize(top_level, file_name, body, options, stats)
* #scan

initialize メソッドは以下の引数を受け取ります。

* top_level RDoc::TopLevel オブジェクトを指定します。
* file_name: file_name ファイル名を文字列で指定します。
* body: ソースコードの内容を文字列で指定します。
*...

rubygems/commands/rdoc_command (18160.0)

RDoc と ri のライブラリを生成するためのライブラリです。

RDoc と ri のライブラリを生成するためのライブラリです。

Usage: gem rdoc [args] [options]
Options:
--all インストールされている全ての Gem パッケージの
RDoc/RI ドキュメントを生成します。
--[no-]rdoc RDoc を含めます
--[no-]ri RI ...

rdoc/context (18100.0)

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

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

絞り込み条件を変える

rdoc/parser/ruby_tools (18100.0)

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのモジュールを定義するサブライブラリです。

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのモジュールを定義するサブライブラリです。

rdoc/markup/to_ansi (18088.0)

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。

require 'rdoc/markup/to_ansi'

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

変換した結果は文字列で取得できます。

rdoc/markup/to_bs (18088.0)

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるサブライブラリです。

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。

require 'rdoc/markup/to_bs'

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

変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。

テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。

* イタリック体(_word_): word にアンダーラインを付けて...

rdoc/markup/to_html (18088.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 (18070.0)

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。

絞り込み条件を変える

rdoc/alias (18052.0)

RDoc::Alias を定義するサブライブラリです。

RDoc::Alias を定義するサブライブラリです。

rdoc/anon_class (18052.0)

RDoc::AnonClass を定義するサブライブラリです。

RDoc::AnonClass を定義するサブライブラリです。

rdoc/any_method (18052.0)

RDoc::AnyMethod を定義するサブライブラリです。

RDoc::AnyMethod を定義するサブライブラリです。

rdoc/attr (18052.0)

RDoc::Attr を定義するサブライブラリです。

RDoc::Attr を定義するサブライブラリです。

rdoc/class_module (18052.0)

RDoc::ClassModule を定義するサブライブラリです。

RDoc::ClassModule を定義するサブライブラリです。

絞り込み条件を変える

rdoc/code_object (18052.0)

RDoc::CodeObject を定義するサブライブラリです。

RDoc::CodeObject を定義するサブライブラリです。

rdoc/constant (18052.0)

RDoc::Constant を定義するサブライブラリです。

RDoc::Constant を定義するサブライブラリです。

rdoc/ghost_method (18052.0)

RDoc::GhostMethod を定義するサブライブラリです。

RDoc::GhostMethod を定義するサブライブラリです。

rdoc/include (18052.0)

RDoc::Include を定義するサブライブラリです。

RDoc::Include を定義するサブライブラリです。

rdoc/markup/formatter (18052.0)

RDoc 形式のドキュメントを整形するためのサブライブラリです。

RDoc 形式のドキュメントを整形するためのサブライブラリです。

絞り込み条件を変える

rdoc/meta_method (18052.0)

RDoc::MetaMethod を定義するサブライブラリです。

RDoc::MetaMethod を定義するサブライブラリです。

rdoc/normal_class (18052.0)

RDoc::NormalClass を定義するサブライブラリです。

RDoc::NormalClass を定義するサブライブラリです。

rdoc/normal_module (18052.0)

RDoc::NormalModule を定義するサブライブラリです。

RDoc::NormalModule を定義するサブライブラリです。

rdoc/options (18052.0)

rdoc コマンドのオプションを解析するためのサブライブラリです。

rdoc コマンドのオプションを解析するためのサブライブラリです。

rdoc/require (18052.0)

RDoc::Require を定義するサブライブラリです。

RDoc::Require を定義するサブライブラリです。

絞り込み条件を変える

rdoc/single_class (18052.0)

RDoc::SingleClass を定義するサブライブラリです。

RDoc::SingleClass を定義するサブライブラリです。

rdoc/stats (18052.0)

RDoc のステータスを管理するサブライブラリです。

RDoc のステータスを管理するサブライブラリです。

rdoc/top_level (18052.0)

RDoc::TopLevel を定義するサブライブラリです。

RDoc::TopLevel を定義するサブライブラリです。

rdoc/generator/json_index (18040.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/c (18040.0)

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

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

C 言語で記述された拡張ライブラリなどを解析するのに使用します。
rb_define_class や rb_define_method などで定義されたものに
対応する C 言語の関数のコメントを解析します。

例: Array#flatten の場合。rb_ary_flatten のコメントが解析されます。

/*
* Returns a new array that is a one-dimensional flattening of this
* arra...

絞り込み条件を変える

rdoc/parser/changelog (18022.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/parser/ruby (18022.0)

Ruby のソースコードを解析するためのサブライブラリです。

Ruby のソースコードを解析するためのサブライブラリです。

拡張子が .rb、.rbw のファイルを解析する事ができます。

=== メタプログラミングされたメソッド

動的に定義されたメソッドをドキュメントに含めたい場合、## でコメントを開始します。

##
# This is a meta-programmed method!

add_my_method :meta_method, :arg1, :arg2

RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行
うような識別子の後に続くトークンをメソッド名として解釈します。...

rdoc/code_objects (18004.0)

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を 表現するためのサブライブラリです。

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を
表現するためのサブライブラリです。

rdoc/generator/darkfish (18004.0)

HTML を生成するためのサブライブラリです。

HTML を生成するためのサブライブラリです。

rdoc/generator/markup (18004.0)

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

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

絞り込み条件を変える

rdoc/generator/ri (18004.0)

ri のためのファイルを生成するためのサブライブラリです。

ri のためのファイルを生成するためのサブライブラリです。

rdoc/known_classes (18004.0)

Ruby の組み込みクラスに関する定数を定義するサブライブラリです。

Ruby の組み込みクラスに関する定数を定義するサブライブラリです。

rdoc/markdown/entities (18004.0)

HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。

HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。

rdoc/parser/markdown (18004.0)

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

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

rdoc/parser/rd (18004.0)

RD 形式で記述されたファイルを解析するためのサブライブラリです。

RD 形式で記述されたファイルを解析するためのサブライブラリです。

絞り込み条件を変える

rdoc/parser/simple (18004.0)

ソースコード以外のファイルを解析するためのサブライブラリです。

ソースコード以外のファイルを解析するためのサブライブラリです。

ファイルの内容すべてを 1 つの大きなコメントとして処理します。ただし、ファ
イルの先頭が # で始まっていた場合、先頭行は削除されます。

rdoc/parser/text (18004.0)

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

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

rdoc/text (18004.0)

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

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

rdoc/token_stream (18004.0)

トークンを管理するためのサブライブラリです。

トークンを管理するためのサブライブラリです。

rubygems (58.0)

RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。

RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。


===[a:gem_command] gem コマンドの使い方

$ gem help

RubyGems は Ruby のための高機能なパッケージ管理ツールです。
これはより多くの情報へのポインタを含んでいる基本的なヘルプメッセージです。

使用方法:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]

例:
...

絞り込み条件を変える

rubygems/commands/install_command (58.0)

Gem パッケージをローカルリポジトリにインストールするためのライブラリです。

Gem パッケージをローカルリポジトリにインストールするためのライブラリです。

Usage: gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]
Options:
--platform PLATFORM 指定されたプラットフォームの Gem パッケージをインストールします
-v, --version VERSION 指定されたバージョンの Gem パッケージをインストールします
Install/Update Op...

rubygems/doc_manager (52.0)

Gem パッケージの RDoc, RI を生成するためのクラスを扱うライブラリです。

Gem パッケージの RDoc, RI を生成するためのクラスを扱うライブラリです。

mkmf (40.0)

Ruby の拡張ライブラリのための Makefile を作成するライブラリです。

...す。
このための extconf.rb は以下のように書きます。

require 'mkmf'

dir_config('bar')
if have_header('bar.h') and have_library('bar', 'baz')
create_makefile('foo')
end

拡張ライブラリ foo.so を作成、インストールするには以下のようにします...

cgi/session (22.0)

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

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

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

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

セッション情報...

drb (22.0)

分散オブジェクトプログラミングのためのライブラリです。

分散オブジェクトプログラミングのためのライブラリです。

Ruby のプロセスから他のRubyプロセスにあるオブジェクトのメソッド
を呼びだすことができます。他のマシン上のプロセスにも
アクセスできます。

=== 概要
dRuby は Ruby 専用の分散オブジェクトシステムです。
Ruby のみで記述され、TCP socket のような Ruby 本体が提供する
通信手段があれば追加のインストール物なしに利用可能です。
独自のプロトコルで通信し、他の分散オブジェクトシステム
(CORBA, RMI, .NETなど)との相互運用性はありません。

dRuby は
* 他のプロセスと Ru...

絞り込み条件を変える

rubygems/commands/server_command (22.0)

ローカルにインストールされている Gem パッケージとそのドキュメントを HTTP サーバに 載せて公開するためのライブラリです。

ローカルにインストールされている Gem パッケージとそのドキュメントを HTTP サーバに
載せて公開するためのライブラリです。

Usage: gem server [options]
Options:
-p, --port=PORT port to listen on
-d, --dir=GEMDIR directory from which to serve gems
--[no-]daemon run as a daemon
...